Emit array marshaller types in 'cswinrtgen'

src/WinRT.Interop.Generator/Builders/InteropTypeDefinitionBuilder.SzArray.cs

@@ -8,6 +8,7 @@
 using AsmResolver.PE.DotNet.Cil;
 using AsmResolver.PE.DotNet.Metadata.Tables;
 using WindowsRuntime.InteropGenerator.Factories;
+using WindowsRuntime.InteropGenerator.Generation;
 using WindowsRuntime.InteropGenerator.References;
 using static AsmResolver.PE.DotNet.Cil.CilOpCodes;
 
@@ -26,121 +27,129 @@ public static class SzArray
         /// </summary>
         /// <param name="arrayType">The <see cref="SzArrayTypeSignature"/> for the SZ array type.</param>
         /// <param name="interopReferences">The <see cref="InteropReferences"/> instance to use.</param>
+        /// <param name="emitState">The emit state for this invocation.</param>
         /// <param name="module">The module that will contain the type being created.</param>
         /// <param name="marshallerType">The resulting marshaller type.</param>
         public static void Marshaller(
             SzArrayTypeSignature arrayType,
             InteropReferences interopReferences,
+            InteropGeneratorEmitState emitState,
             ModuleDefinition module,
             out TypeDefinition marshallerType)
         {
             TypeSignature elementType = arrayType.BaseType;
-            TypeSignature elementAbiType = elementType.GetAbiType(interopReferences);
 
-            // We're declaring an 'internal static class' type
-            marshallerType = new(
-                ns: InteropUtf8NameFactory.TypeNamespace(arrayType),
-                name: InteropUtf8NameFactory.TypeName(arrayType, "Marshaller"),
-                attributes: TypeAttributes.AutoLayout | TypeAttributes.Sealed | TypeAttributes.Abstract | TypeAttributes.BeforeFieldInit,
-                baseType: module.CorLibTypeFactory.Object.ToTypeDefOrRef());
-
-            module.TopLevelTypes.Add(marshallerType);
-
-            // Define the 'ConvertToUnmanaged' method as follows:
-            //
-            // public static void ConvertToUnmanaged(ReadOnlySpan<<ELEMENT_TYPE>>, out uint size, out <ABI_ELEMENT_TYPE>* array)
-            MethodDefinition convertToUnmanagedMethod = new(
-                name: "ConvertToUnmanaged"u8,
-                attributes: MethodAttributes.Public | MethodAttributes.Static | MethodAttributes.HideBySig,
-                signature: MethodSignature.CreateStatic(
-                    returnType: module.CorLibTypeFactory.Void,
-                    parameterTypes: [
-                        interopReferences.ReadOnlySpan1.MakeGenericValueType(elementType).Import(module),
-                        module.CorLibTypeFactory.UInt32.MakeByReferenceType(),
-                        elementAbiType.Import(module).MakePointerType().MakeByReferenceType()]))
+            // Emit the right marshaller based on the element type. We special case all different
+            // kinds of element types because some need specialized marshallers, and some need
+            // a generated element marshaller type. The marshaller itself just forwards all calls.
+            if (elementType.IsBlittable(interopReferences))
             {
-                CilOutParameterIndices = [2, 3],
-                CilInstructions =
-                {
-                    { Ldnull },
-                    { Throw } // TODO
-                }
-            };
-
-            marshallerType.Methods.Add(convertToUnmanagedMethod);
-
-            // Define the 'ConvertToManaged' method as follows:
-            //
-            // public static <ELEMENT_TYPE>[] ConvertToManaged(uint size, <ABI_ELEMENT_TYPE>* value)
-            MethodDefinition convertToManagedMethod = new(
-                name: "ConvertToManaged"u8,
-                attributes: MethodAttributes.Public | MethodAttributes.Static | MethodAttributes.HideBySig,
-                signature: MethodSignature.CreateStatic(
-                    returnType: arrayType.Import(module),
-                    parameterTypes: [
-                        module.CorLibTypeFactory.UInt32,
-                        elementAbiType.Import(module).MakePointerType()]))
+                marshallerType = InteropTypeDefinitionFactory.SzArrayMarshaller.BlittableValueType(
+                    arrayType: arrayType,
+                    interopReferences: interopReferences,
+                    module: module);
+
+                module.TopLevelTypes.Add(marshallerType);
+            }
+            else if (elementType.IsConstructedKeyValuePairType(interopReferences))
             {
-                CilInstructions =
-                {
-                    { Ldnull },
-                    { Throw } // TODO
-                }
-            };
-
-            marshallerType.Methods.Add(convertToManagedMethod);
-
-            // Define the 'CopyToManaged' method as follows:
-            //
-            // public static void CopyToManaged(uint size, <ABI_ELEMENT_TYPE>* value, Span<<ELEMENT_TYPE>> destination)
-            MethodDefinition copyToManagedMethod = new(
-                name: "CopyToManaged"u8,
-                attributes: MethodAttributes.Public | MethodAttributes.Static | MethodAttributes.HideBySig,
-                signature: MethodSignature.CreateStatic(
-                    returnType: module.CorLibTypeFactory.Void,
-                    parameterTypes: [
-                        module.CorLibTypeFactory.UInt32,
-                        elementAbiType.Import(module).MakePointerType(),
-                        interopReferences.Span1.MakeGenericValueType(elementType).Import(module)]))
+                TypeDefinition elementMarshallerType = InteropTypeDefinitionFactory.SzArrayElementMarshaller.KeyValuePair(
+                    arrayType: arrayType,
+                    interopReferences: interopReferences,
+                    emitState: emitState,
+                    module: module);
+
+                module.TopLevelTypes.Add(elementMarshallerType);
+
+                marshallerType = InteropTypeDefinitionFactory.SzArrayMarshaller.KeyValuePair(
+                    arrayType: arrayType,
+                    elementMarshallerType: elementMarshallerType,
+                    interopReferences: interopReferences,
+                    module: module);
+
+                module.TopLevelTypes.Add(marshallerType);
+            }
+            else if (elementType.IsManagedValueType(interopReferences))
             {
-                CilInstructions =
-                {
-                    { Ldnull },
-                    { Throw } // TODO
-                }
-            };
-
-            marshallerType.Methods.Add(copyToManagedMethod);
-
-            // Define the 'CopyToUnmanaged' method as follows:
-            //
-            // public static void CopyToUnmanaged(ReadOnlySpan<<ELEMENT_TYPE>> value, uint size, <ABI_ELEMENT_TYPE>* destination)
-            MethodDefinition copyToUnmanagedMethod = new(
-                name: "CopyToUnmanaged"u8,
-                attributes: MethodAttributes.Public | MethodAttributes.Static | MethodAttributes.HideBySig,
-                signature: MethodSignature.CreateStatic(
-                    returnType: module.CorLibTypeFactory.Void,
-                    parameterTypes: [
-                        interopReferences.ReadOnlySpan1.MakeGenericValueType(elementType).Import(module),
-                        module.CorLibTypeFactory.UInt32,
-                        elementAbiType.Import(module).MakePointerType()]))
+                TypeDefinition elementMarshallerType = InteropTypeDefinitionFactory.SzArrayElementMarshaller.ManagedValueType(
+                    arrayType: arrayType,
+                    interopReferences: interopReferences,
+                    emitState: emitState,
+                    module: module);
+
+                module.TopLevelTypes.Add(elementMarshallerType);
+
+                marshallerType = InteropTypeDefinitionFactory.SzArrayMarshaller.ManagedValueType(
+                    arrayType: arrayType,
+                    elementMarshallerType: elementMarshallerType,
+                    interopReferences: interopReferences,
+                    module: module);
+
+                module.TopLevelTypes.Add(marshallerType);
+            }
+            else if (elementType.IsValueType)
             {
-                CilInstructions =
-                {
-                    { Ldnull },
-                    { Throw } // TODO
-                }
-            };
-
-            marshallerType.Methods.Add(copyToUnmanagedMethod);
-
-            // Define the 'Free' method
-            MethodDefinition freeMethod = InteropMethodDefinitionFactory.SzArrayMarshaller.Free(
-                arrayType,
-                interopReferences,
-                module);
-
-            marshallerType.Methods.Add(freeMethod);
+                TypeDefinition elementMarshallerType = InteropTypeDefinitionFactory.SzArrayElementMarshaller.UnmanagedValueType(
+                    arrayType: arrayType,
+                    interopReferences: interopReferences,
+                    emitState: emitState,
+                    module: module);
+
+                module.TopLevelTypes.Add(elementMarshallerType);
+
+                marshallerType = InteropTypeDefinitionFactory.SzArrayMarshaller.UnmanagedValueType(
+                    arrayType: arrayType,
+                    elementMarshallerType: elementMarshallerType,
+                    interopReferences: interopReferences,
+                    module: module);
+
+                module.TopLevelTypes.Add(marshallerType);
+            }
+            else if (elementType.IsTypeOfString())
+            {
+                marshallerType = InteropTypeDefinitionFactory.SzArrayMarshaller.String(
+                    arrayType: arrayType,
+                    interopReferences: interopReferences,
+                    module: module);
+
+                module.TopLevelTypes.Add(marshallerType);
+            }
+            else if (elementType.IsTypeOfType(interopReferences))
+            {
+                marshallerType = InteropTypeDefinitionFactory.SzArrayMarshaller.Type(
+                    arrayType: arrayType,
+                    interopReferences: interopReferences,
+                    module: module);
+
+                module.TopLevelTypes.Add(marshallerType);
+            }
+            else if (elementType.IsTypeOfException(interopReferences))
+            {
+                marshallerType = InteropTypeDefinitionFactory.SzArrayMarshaller.Exception(
+                    arrayType: arrayType,
+                    interopReferences: interopReferences,
+                    module: module);
+
+                module.TopLevelTypes.Add(marshallerType);
+            }
+            else
+            {
+                TypeDefinition elementMarshallerType = InteropTypeDefinitionFactory.SzArrayElementMarshaller.ReferenceType(
+                    arrayType: arrayType,
+                    interopReferences: interopReferences,
+                    emitState: emitState,
+                    module: module);
+
+                module.TopLevelTypes.Add(elementMarshallerType);
+
+                marshallerType = InteropTypeDefinitionFactory.SzArrayMarshaller.ReferenceType(
+                    arrayType: arrayType,
+                    elementMarshallerType: elementMarshallerType,
+                    interopReferences: interopReferences,
+                    module: module);
+
+                module.TopLevelTypes.Add(marshallerType);
+            }
         }
 
         /// <summary>

src/WinRT.Interop.Generator/Errors/WellKnownInteropExceptions.cs

@@ -597,6 +597,14 @@ public static WellKnownInteropException MethodRewriteSourceParameterTypeMismatch
         return Exception(69, $"Parameter variable of type '{parameterType}' cannot be used to marshal a value of type '{returnType}' in generated interop method '{method}'.");
     }
 
+    /// <summary>
+    /// A type doesn't have the <c>Dispose</c> method available.
+    /// </summary>
+    public static WellKnownInteropException MethodRewriteDisposeNotAvailableError(TypeSignature parameterType, MethodDefinition method)
+    {
+        return Exception(70, $"Value of type '{parameterType}' in generated interop method '{method}' cannot be disposed, as it is an unmanaged (or blittable) value type.");
+    }
+
     /// <summary>
     /// Creates a new exception with the specified id and message.
     /// </summary>

src/WinRT.Interop.Generator/Extensions/WindowsRuntimeExtensions.cs

@@ -583,6 +583,22 @@ public TypeSignature GetAbiType(InteropReferences interopReferences)
             // For all other cases (e.g. interfaces, classes, delegates, etc.), the ABI type is always a pointer
             return interopReferences.CorLibTypeFactory.Void.MakePointerType();
         }
+
+        /// <summary>
+        /// Gets the raw ABI type for a given type (without unwrapping).
+        /// </summary>
+        /// <param name="interopReferences">The <see cref="InteropReferences"/> instance to use.</param>
+        /// <returns>The raw ABI type for the input type.</returns>
+        public TypeSignature GetRawAbiType(InteropReferences interopReferences)
+        {
+            TypeSignature abiType = type.GetAbiType(interopReferences);
+
+            // If the ABI type is 'void*', the marshaller types return it as 'WindowsRuntimeObjectReferenceValue'.
+            // This allows callers to do proper lifetime management. For all other cases, the ABI type is the same.
+            return abiType.IsTypeOfVoidPointer()
+                ? interopReferences.WindowsRuntimeObjectReferenceValue.ToValueTypeSignature()
+                : abiType;
+        }
     }
 
     extension(TypeDefinition type)

src/WinRT.Interop.Generator/Factories/InteropMethodDefinitionFactory.IEnumerator1Impl.cs

@@ -15,10 +15,8 @@
 
 namespace WindowsRuntime.InteropGenerator.Factories;
 
-/// <summary>
-/// A factory for interop method definitions.
-/// </summary>
-internal static partial class InteropMethodDefinitionFactory
+/// <inheritdoc cref="InteropMethodDefinitionFactory"/>
+internal partial class InteropMethodDefinitionFactory
 {
     /// <summary>
     /// Helpers for impl types for <see cref="System.Collections.Generic.IEnumerator{T}"/> interfaces.

src/WinRT.Interop.Generator/Factories/InteropMethodDefinitionFactory.IList1Impl.cs

@@ -15,10 +15,8 @@
 
 namespace WindowsRuntime.InteropGenerator.Factories;
 
-/// <summary>
-/// A factory for interop method definitions.
-/// </summary>
-internal static partial class InteropMethodDefinitionFactory
+/// <inheritdoc cref="InteropMethodDefinitionFactory"/>
+internal partial class InteropMethodDefinitionFactory
 {
     /// <summary>
     /// Helpers for impl types for <see cref="System.Collections.Generic.IList{T}"/> interfaces.

src/WinRT.Interop.Generator/Factories/InteropMethodDefinitionFactory.IReadOnlyDictionary2Impl.cs

@@ -14,10 +14,8 @@
 
 namespace WindowsRuntime.InteropGenerator.Factories;
 
-/// <summary>
-/// A factory for interop method definitions.
-/// </summary>
-internal static partial class InteropMethodDefinitionFactory
+/// <inheritdoc cref="InteropMethodDefinitionFactory"/>
+internal partial class InteropMethodDefinitionFactory
 {
     /// <summary>
     /// Helpers for impl types for <see cref="System.Collections.Generic.IReadOnlyDictionary{TKey, TValue}"/> interfaces.

src/WinRT.Interop.Generator/Factories/InteropMethodDefinitionFactory.IReadOnlyList1Impl.cs

@@ -14,10 +14,8 @@
 
 namespace WindowsRuntime.InteropGenerator.Factories;
 
-/// <summary>
-/// A factory for interop method definitions.
-/// </summary>
-internal static partial class InteropMethodDefinitionFactory
+/// <inheritdoc cref="InteropMethodDefinitionFactory"/>
+internal partial class InteropMethodDefinitionFactory
 {
     /// <summary>
     /// Helpers for impl types for <see cref="System.Collections.Generic.IReadOnlyList{T}"/> interfaces.