Merge pull request #1119 from gircore/improve-alias-support

Improve alias support

src/Generation/Generator/Renderer/Internal/ParameterToManagedExpression/Converter/Callback.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using Generator.Renderer.Public;
 
 namespace Generator.Renderer.Internal.ParameterToManagedExpressions;
 
@@ -21,15 +22,14 @@ public void Initialize(ParameterToManagedData parameterData, IEnumerable<Paramet
         var signatureName = Model.Parameter.GetName(parameterData.Parameter);
         var callName = signatureName + "Managed";
 
-        var parameterToNativeDatas = Public.ParameterToNativeExpression.Initialize(callback.Parameters);
-
+        var callableData = Public.CallableExpressions.Initialize(callback);
         parameterData.SetSignatureName(() => signatureName);
-        parameterData.SetExpression(() => @$"var {callName} = new {ns}.{type}(({GetManagedParameters(parameterToNativeDatas)}) => 
+        parameterData.SetExpression(() => @$"var {callName} = new {ns}.{type}(({GetManagedParameters(callableData.ParameterToNativeDatas)}) => 
 {{ 
-    {RenderContent(parameterToNativeDatas)}
-    {RenderCallStatement(signatureName, callback, parameterToNativeDatas, out var resultVariableName)}
-    {RenderThrowOnError(callback, parameterToNativeDatas)}
-    {RenderReturnStatement(callback, resultVariableName)}
+    {RenderContent(callableData.ParameterToNativeDatas)}
+    {RenderCallStatement(signatureName, callback, callableData.ParameterToNativeDatas, out var resultVariableName)}
+    {RenderThrowOnError(callback, callableData.ParameterToNativeDatas)}
+    {RenderReturnStatement(callableData.ReturnTypeToManagedData, resultVariableName)}
 }});");
         parameterData.SetCallName(() => callName);
     }
@@ -67,7 +67,7 @@ private static string RenderContent(IEnumerable<Public.ParameterToNativeData> pa
             .Join(Environment.NewLine);
     }
 
-    private static string RenderCallStatement(string signatureName, GirModel.Callback callback, IReadOnlyList<Public.ParameterToNativeData> parameters, out string resultVariableName)
+    private static string RenderCallStatement(string signatureName, GirModel.Callback callback, IReadOnlyCollection<Public.ParameterToNativeData> parameters, out string resultVariableName)
     {
         resultVariableName = $"result{callback.Name}";
         var call = new StringBuilder();
@@ -91,10 +91,10 @@ private static string RenderThrowOnError(GirModel.Callback callback, IEnumerable
             : string.Empty;
     }
 
-    private static string RenderReturnStatement(GirModel.Callback callback, string returnVariable)
+    private static string RenderReturnStatement(ReturnTypeToManagedData data, string returnVariable)
     {
-        return callback.ReturnType.AnyType.Is<GirModel.Void>()
+        return data.ReturnType.AnyType.Is<GirModel.Void>()
             ? string.Empty
-            : $"return {Public.ReturnTypeToManagedExpression.Render(callback.ReturnType, returnVariable)};";
+            : $"return {data.GetExpression(returnVariable)};";
     }
 }

src/Generation/Generator/Renderer/Internal/ReturnType/Converter/PrimitiveValueTypeAliasArray.cs

@@ -0,0 +1,20 @@
+using System;
+using Type = Generator.Model.Type;
+
+namespace Generator.Renderer.Internal.ReturnType;
+
+internal class PrimitiveValueTypeAliasArray : ReturnTypeConverter
+{
+    public bool Supports(GirModel.ReturnType returnType)
+    {
+        return returnType.AnyType.IsArrayAlias<GirModel.PrimitiveValueType>();
+    }
+
+    public RenderableReturnType Convert(GirModel.ReturnType returnType)
+    {
+        if (!returnType.IsPointer)
+            throw new NotImplementedException("Only primitive value types alias arrays which are pointer based are supported.");
+
+        return new RenderableReturnType(Type.Pointer);
+    }
+}

src/Generation/Generator/Renderer/Internal/ReturnType/ReturnTypeRenderer.cs

@@ -23,6 +23,7 @@ internal static class ReturnTypeRenderer
         new ReturnType.UnsignedLong(), //Must be before primitive value type
         new ReturnType.PrimitiveValueType(),
         new ReturnType.PrimitiveValueTypeAlias(),
+        new ReturnType.PrimitiveValueTypeAliasArray(),
         new ReturnType.PrimitiveValueTypeArray(),
         new ReturnType.TypedRecord(),
         new ReturnType.TypedRecordArray(),

src/Generation/Generator/Renderer/Public/AliasPrimitiveValueType.cs

@@ -26,7 +26,7 @@ namespace {Namespace.GetPublicName(alias.Namespace)};
 
 {PlatformSupportAttribute.Render(alias as GirModel.PlatformDependent)}
 [StructLayout(LayoutKind.Explicit)]
-public readonly partial struct {alias.Name} 
+public readonly partial record struct {alias.Name} 
 {{
     [FieldOffset(0)]
     private readonly {type} _value;

src/Generation/Generator/Renderer/Public/CallableExpressions/CallableData.cs

@@ -0,0 +1,8 @@
+using System.Collections.Generic;
+
+namespace Generator.Renderer.Public;
+
+public record CallableData(
+    ReturnTypeToManagedData ReturnTypeToManagedData,
+    IReadOnlyCollection<ParameterToNativeData> ParameterToNativeDatas
+);

src/Generation/Generator/Renderer/Public/CallableExpressions/CallableExpressions.cs

@@ -0,0 +1,12 @@
+namespace Generator.Renderer.Public;
+
+public class CallableExpressions
+{
+    public static CallableData Initialize(GirModel.Callable callable)
+    {
+        var parameters = ParameterToNativeExpression.Initialize(callable.Parameters);
+        var returnType = ReturnTypeToManagedExpression.Initialize(callable.ReturnType, parameters);
+
+        return new CallableData(returnType, parameters);
+    }
+}

src/Generation/Generator/Renderer/Public/FunctionRenderer.cs

@@ -18,16 +18,17 @@ public static string Render(GirModel.Function? function)
 
         try
         {
-            var parameters = ParameterToNativeExpression.Initialize(function.Parameters);
+            var callableData = CallableExpressions.Initialize(function);
             var newModifier = Function.HidesFunction(function) ? "new " : string.Empty;
             return @$"
 {VersionAttribute.Render(function.Version)}
-public static {newModifier}{ReturnTypeRenderer.Render(function.ReturnType)} {Function.GetName(function)}({RenderParameters(parameters)})
+public static {newModifier}{ReturnTypeRenderer.Render(function.ReturnType)} {Function.GetName(function)}({RenderParameters(callableData.ParameterToNativeDatas)})
 {{
-    {RenderFunctionContent(parameters)}
-    {RenderCallStatement(function, parameters, out var resultVariableName)}
-    {RenderPostCallContent(parameters)}
-    {RenderReturnStatement(function, resultVariableName)}
+    {RenderFunctionContent(callableData.ParameterToNativeDatas)}
+    {RenderCallStatement(function, callableData.ParameterToNativeDatas, out var resultVariableName)}
+    {RenderPostCallContent(callableData.ParameterToNativeDatas)}
+    {callableData.ReturnTypeToManagedData.GetPostReturnStatement(resultVariableName)}
+    {RenderReturnStatement(callableData.ReturnTypeToManagedData, resultVariableName)}
 }}";
         }
         catch (Exception e)
@@ -89,7 +90,7 @@ private static string RenderParameters(IEnumerable<ParameterToNativeData> parame
         return result.Join(", ");
     }
 
-    private static string RenderCallStatement(GirModel.Function function, IReadOnlyList<ParameterToNativeData> parameters, out string resultVariableName)
+    private static string RenderCallStatement(GirModel.Function function, IEnumerable<ParameterToNativeData> parameters, out string resultVariableName)
     {
         resultVariableName = $"result{Function.GetName(function)}";
         var call = new StringBuilder();
@@ -113,11 +114,11 @@ private static string RenderCallStatement(GirModel.Function function, IReadOnlyL
         return call.ToString();
     }
 
-    private static string RenderReturnStatement(GirModel.Function function, string returnVariable)
+    private static string RenderReturnStatement(ReturnTypeToManagedData data, string returnVariable)
     {
-        return function.ReturnType.AnyType.Is<GirModel.Void>()
+        return data.ReturnType.AnyType.Is<GirModel.Void>()
             ? string.Empty
-            : $"return {ReturnTypeToManagedExpression.Render(function.ReturnType, returnVariable)};";
+            : $"return {data.GetExpression(returnVariable)};";
     }
 
     private static bool IsSupported(GirModel.Function function)

src/Generation/Generator/Renderer/Public/MethodRenderer.cs

@@ -25,16 +25,16 @@ public static string Render(GirModel.Method method)
                 explicitImplementation = $"{Namespace.GetPublicName(method.Parent.Namespace)}.{method.Parent.Name}.";
             }
 
-            var parameters = ParameterToNativeExpression.Initialize(method.Parameters);
-
+            var callableData = CallableExpressions.Initialize(method);
             return @$"
 {VersionAttribute.Render(method.Version)}
-{modifier}{ReturnTypeRenderer.Render(method.ReturnType)} {explicitImplementation}{Method.GetPublicName(method)}({RenderParameters(parameters)})
+{modifier}{ReturnTypeRenderer.Render(method.ReturnType)} {explicitImplementation}{Method.GetPublicName(method)}({RenderParameters(callableData.ParameterToNativeDatas)})
 {{
-    {RenderMethodContent(parameters)}
-    {RenderCallStatement(method, parameters, out var resultVariableName)}
-    {RenderPostCallContent(parameters)}
-    {RenderReturnStatement(method, resultVariableName)}
+    {RenderMethodContent(callableData.ParameterToNativeDatas)}
+    {RenderCallStatement(method, callableData.ParameterToNativeDatas, out var resultVariableName)}
+    {RenderPostCallContent(callableData.ParameterToNativeDatas)}
+    {callableData.ReturnTypeToManagedData.GetPostReturnStatement(resultVariableName)}
+    {RenderReturnStatement(callableData.ReturnTypeToManagedData, resultVariableName)}
 }}";
         }
         catch (Exception e)
@@ -96,7 +96,7 @@ private static string RenderParameters(IEnumerable<ParameterToNativeData> parame
         return result.Join(", ");
     }
 
-    private static string RenderCallStatement(GirModel.Method method, IReadOnlyList<ParameterToNativeData> parameters, out string resultVariableName)
+    private static string RenderCallStatement(GirModel.Method method, IReadOnlyCollection<ParameterToNativeData> parameters, out string resultVariableName)
     {
         resultVariableName = $"result{Method.GetPublicName(method)}";
         var call = new StringBuilder();
@@ -115,10 +115,10 @@ private static string RenderCallStatement(GirModel.Method method, IReadOnlyList<
         return call.ToString();
     }
 
-    private static string RenderReturnStatement(GirModel.Method method, string returnVariable)
+    private static string RenderReturnStatement(ReturnTypeToManagedData data, string returnVariable)
     {
-        return method.ReturnType.AnyType.Is<GirModel.Void>()
+        return data.ReturnType.AnyType.Is<GirModel.Void>()
             ? string.Empty
-            : $"return {ReturnTypeToManagedExpression.Render(method.ReturnType, returnVariable)};";
+            : $"return {data.GetExpression(returnVariable)};";
     }
 }

src/Generation/Generator/Renderer/Public/ParameterToNativeExpression/Converter/PrimitiveValueType.cs

@@ -51,6 +51,8 @@ private static void Out(ParameterToNativeData parameter)
     {
         var parameterName = Model.Parameter.GetName(parameter.Parameter);
         parameter.SetSignatureName(() => parameterName);
-        parameter.SetCallName(() => $"out {parameterName}");
+        parameter.SetCallName(() => parameter.IsArrayLengthParameter
+            ? $"out var {parameterName}"
+            : $"out {parameterName}");
     }
 }

src/Generation/Generator/Renderer/Public/ParameterToNativeExpression/ParameterToNativeData.cs

@@ -2,7 +2,7 @@
 
 namespace Generator.Renderer.Public;
 
-public class ParameterToNativeData
+public class ParameterToNativeData(GirModel.Parameter parameter)
 {
     private Func<string>? _getCallName;
     private Func<string>? _getSignatureName;
@@ -14,19 +14,14 @@ public class ParameterToNativeData
     private string? _expression;
     private string? _postCallExpression;
 
-    public GirModel.Parameter Parameter { get; }
+    public GirModel.Parameter Parameter { get; } = parameter;
 
     public bool IsCallbackUserData { get; internal set; }
     public bool IsDestroyNotify { get; internal set; }
     public bool IsArrayLengthParameter { get; internal set; }
     public bool IsInOutArrayLengthParameter { get; internal set; }
     public bool IsGLibErrorParameter { get; internal set; }
 
-    public ParameterToNativeData(GirModel.Parameter parameter)
-    {
-        Parameter = parameter;
-    }
-
     public void SetExpression(Func<string> getExpression)
     {
         _getExpression = getExpression;

src/Generation/Generator/Renderer/Public/ReturnType/Converter/PrimitiveValueTypeAliasArray.cs

@@ -0,0 +1,18 @@
+using System;
+
+namespace Generator.Renderer.Public.ReturnType;
+
+internal class PrimitiveValueTypeAliasArray : ReturnTypeConverter
+{
+    public RenderableReturnType Create(GirModel.ReturnType returnType)
+    {
+        if (!returnType.IsPointer)
+            throw new NotImplementedException("Only primitive value types alias arrays which are pointer based are supported.");
+
+        var alias = (GirModel.Alias) returnType.AnyType.AsT1.AnyType.AsT0;
+        return new RenderableReturnType($"{Model.Namespace.GetPublicName(alias.Namespace)}.{Model.ArrayType.GetName(returnType.AnyType.AsT1)}");
+    }
+
+    public bool Supports(GirModel.ReturnType returnType)
+        => returnType.AnyType.IsArrayAlias<GirModel.PrimitiveValueType>();
+}

src/Generation/Generator/Renderer/Public/ReturnType/ReturnTypeRenderer.cs

@@ -5,8 +5,8 @@ namespace Generator.Renderer.Public;
 
 internal static class ReturnTypeRenderer
 {
-    private static readonly List<ReturnType.ReturnTypeConverter> converters = new()
-    {
+    private static readonly List<ReturnType.ReturnTypeConverter> converters =
+    [
         new ReturnType.Bitfield(),
         new ReturnType.Class(),
         new ReturnType.Enumeration(),
@@ -18,13 +18,14 @@ internal static class ReturnTypeRenderer
         new ReturnType.PointerAlias(),
         new ReturnType.PrimitiveValueType(),
         new ReturnType.PrimitiveValueTypeAlias(),
+        new ReturnType.PrimitiveValueTypeAliasArray(),
         new ReturnType.String(),
         new ReturnType.StringArray(),
         new ReturnType.TypedRecord(),
         new ReturnType.TypedRecordArray(),
         new ReturnType.UntypedRecord(),
-        new ReturnType.Void(),
-    };
+        new ReturnType.Void()
+    ];
 
     public static string Render(GirModel.ReturnType returnType)
     {

src/Generation/Generator/Renderer/Public/ReturnTypeToManagedExpression/Converter/Bitfield.cs

@@ -1,4 +1,5 @@
-using GirModel;
+using System.Collections.Generic;
+using GirModel;
 
 namespace Generator.Renderer.Public.ReturnTypeToManagedExpressions;
 
@@ -7,6 +8,6 @@ internal class Bitfield : ReturnTypeConverter
     public bool Supports(AnyType type)
         => type.Is<GirModel.Bitfield>();
 
-    public string GetString(GirModel.ReturnType returnType, string fromVariableName)
-        => fromVariableName;
+    public void Initialize(ReturnTypeToManagedData data, IEnumerable<ParameterToNativeData> _)
+        => data.SetExpression(fromVariableName => fromVariableName);
 }

src/Generation/Generator/Renderer/Public/ReturnTypeToManagedExpression/Converter/Class.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using Generator.Model;
 
 namespace Generator.Renderer.Public.ReturnTypeToManagedExpressions;
@@ -8,15 +9,20 @@ internal class Class : ReturnTypeConverter
     public bool Supports(GirModel.AnyType type)
         => type.Is<GirModel.Class>();
 
-    public string GetString(GirModel.ReturnType returnType, string fromVariableName)
+    public void Initialize(ReturnTypeToManagedData data, IEnumerable<ParameterToNativeData> _)
     {
-        if (!returnType.IsPointer)
-            throw new NotImplementedException($"Can't convert {returnType} to managed as it is a pointer");
+        data.SetExpression(fromVariableName =>
+        {
+            var returnType = data.ReturnType;
 
-        var cls = (GirModel.Class) returnType.AnyType.AsT0;
-        return cls.Fundamental
-            ? Fundamental(cls, returnType, fromVariableName)
-            : Standard(cls, returnType, fromVariableName);
+            if (!returnType.IsPointer)
+                throw new NotImplementedException($"Can't convert {returnType} to managed as it is a pointer");
+
+            var cls = (GirModel.Class) returnType.AnyType.AsT0;
+            return cls.Fundamental
+                ? Fundamental(cls, returnType, fromVariableName)
+                : Standard(cls, returnType, fromVariableName);
+        });
     }
 
     private static string Fundamental(GirModel.Class cls, GirModel.ReturnType returnType, string fromVariableName)

src/Generation/Generator/Renderer/Public/ReturnTypeToManagedExpression/Converter/Enumeration.cs

@@ -1,4 +1,5 @@
-using GirModel;
+using System.Collections.Generic;
+using GirModel;
 
 namespace Generator.Renderer.Public.ReturnTypeToManagedExpressions;
 
@@ -7,6 +8,6 @@ internal class Enumeration : ReturnTypeConverter
     public bool Supports(AnyType type)
         => type.Is<GirModel.Enumeration>();
 
-    public string GetString(GirModel.ReturnType returnType, string fromVariableName)
-        => fromVariableName;
+    public void Initialize(ReturnTypeToManagedData data, IEnumerable<ParameterToNativeData> _)
+        => data.SetExpression(fromVariableName => fromVariableName);
 }