Merge pull request #994 from gircore/typed-record-field-access

TypedRecord: Add field access
gircore · Jan 12, 2024 · 8847a1d · 8847a1d
2 parents 14cd764 + bd0856d
commit 8847a1d
Show file tree

Hide file tree

Showing 16 changed files with 336 additions and 9 deletions.
diff --git a/src/Generation/Generator/Fixer/Record/PublicMethodsColldingWithPropertiesFixer.cs b/src/Generation/Generator/Fixer/Record/PublicMethodsColldingWithPropertiesFixer.cs
@@ -0,0 +1,31 @@
+using Generator.Model;
+
+namespace Generator.Fixer.Record;
+
+internal class PublicMethodsColldingWithFieldFixer : Fixer<GirModel.Record>
+{
+    public void Fixup(GirModel.Record record)
+    {
+        foreach (var field in record.Fields)
+        {
+            foreach (var method in record.Methods)
+            {
+                if (Field.GetName(field) == Method.GetPublicName(method))
+                {
+                    if (method.ReturnType.AnyType.Is<GirModel.Void>())
+                    {
+                        Log.Warning($"{record.Namespace.Name}.{record.Name}: Method {Method.GetPublicName(method)} is named like a field but returns no value. It makes no sense to prefix the method with 'Get'. Thus it will be ignored.");
+                        Method.Disable(method);
+                    }
+                    else
+                    {
+                        var newName = $"Get{Method.GetPublicName(method)}";
+                        Log.Warning($"{record.Namespace.Name}.{record.Name}: Method {Method.GetPublicName(method)} collides with field {Field.GetName(field)} and is renamed to {newName}.");
+
+                        Method.SetPublicName(method, newName);
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/src/Generation/Generator/Fixer/Records.cs b/src/Generation/Generator/Fixer/Records.cs
@@ -7,7 +7,8 @@ public static class Records
 {
     private static readonly List<Fixer<GirModel.Record>> Fixers = new()
     {
-        new InternalMethodsNamedLikeRecordFixer()
+        new InternalMethodsNamedLikeRecordFixer(),
+        new PublicMethodsColldingWithFieldFixer()
     };
 
     public static void Fixup(IEnumerable<GirModel.Record> records)

diff --git a/src/Generation/Generator/Renderer/Internal/Field/Converter/String.cs b/src/Generation/Generator/Renderer/Internal/Field/Converter/String.cs
@@ -13,8 +13,8 @@ public RenderableField Convert(GirModel.Field field)
     {
         return new RenderableField(
             Name: Model.Field.GetName(field),
-            Attribute: MarshalAs.UnmanagedLpString(),
-            NullableTypeName: Type.GetName(field.AnyTypeOrCallback.AsT0.AsT0)
+            Attribute: null,
+            NullableTypeName: Type.Pointer
         );
     }
 }
diff --git a/src/Generation/Generator/Renderer/Internal/TypedRecordHandle.cs b/src/Generation/Generator/Renderer/Internal/TypedRecordHandle.cs
@@ -252,8 +252,7 @@ private static string RenderFieldGetter(GirModel.Record record, GirModel.Field f
     if (IsClosed || IsInvalid)
         throw new InvalidOperationException(""Handle is closed or invalid"");
 
-    var data = Unsafe.AsRef<{dataName}>((void*)handle);
-    return data.{renderableField.Name};
+    return Unsafe.AsRef<{dataName}>((void*)handle).{renderableField.Name};
 }}";
     }
 
@@ -266,8 +265,7 @@ private static string RenderFieldSetter(GirModel.Record record, GirModel.Field f
     if (IsClosed || IsInvalid)
         throw new InvalidOperationException(""Handle is closed or invalid"");
 
-    var data = Unsafe.AsRef<{dataName}>((void*)handle);
-    data.{renderableField.Name} = value;
+    Unsafe.AsRef<{dataName}>((void*)handle).{renderableField.Name} = value;
 }}";
     }
 

diff --git a/src/Generation/Generator/Renderer/Public/Field/Converter/Bitfield.cs b/src/Generation/Generator/Renderer/Public/Field/Converter/Bitfield.cs
@@ -0,0 +1,39 @@
+namespace Generator.Renderer.Public.Field;
+
+internal class Bitfield : FieldConverter
+{
+    public bool Supports(GirModel.Field field)
+    {
+        return field.AnyTypeOrCallback.TryPickT0(out var anyType, out _) && anyType.Is<GirModel.Bitfield>();
+    }
+
+    public RenderableField Convert(GirModel.Field field)
+    {
+        var name = Model.Field.GetName(field);
+        return new RenderableField(
+            Name: name,
+            NullableTypeName: GetNullableTypeName(field),
+            SetExpression: SetExpression,
+            GetExpression: GetExpression
+        );
+    }
+
+    private static string GetNullableTypeName(GirModel.Field field)
+    {
+        var type = (GirModel.Bitfield) field.AnyTypeOrCallback.AsT0.AsT0;
+        return field.IsPointer
+            ? Model.Type.Pointer
+            : Model.ComplexType.GetFullyQualified(type);
+    }
+
+    private static string SetExpression(GirModel.Record record, GirModel.Field field)
+    {
+        return $"Handle.Set{Model.Field.GetName(field)}(value)";
+    }
+
+    private static string GetExpression(GirModel.Record record, GirModel.Field field)
+    {
+        return $"Handle.Get{Model.Field.GetName(field)}()";
+    }
+}
+
diff --git a/src/Generation/Generator/Renderer/Public/Field/Converter/Enumeration.cs b/src/Generation/Generator/Renderer/Public/Field/Converter/Enumeration.cs
@@ -0,0 +1,37 @@
+namespace Generator.Renderer.Public.Field;
+
+internal class Enumeration : FieldConverter
+{
+    public bool Supports(GirModel.Field field)
+    {
+        return field.AnyTypeOrCallback.TryPickT0(out var anyType, out _) && anyType.Is<GirModel.Enumeration>();
+    }
+
+    public RenderableField Convert(GirModel.Field field)
+    {
+        return new RenderableField(
+            Name: Model.Field.GetName(field),
+            NullableTypeName: GetNullableTypeName(field),
+            SetExpression: SetExpression,
+            GetExpression: GetExpression
+        );
+    }
+
+    private static string GetNullableTypeName(GirModel.Field field)
+    {
+        var type = (GirModel.Enumeration) field.AnyTypeOrCallback.AsT0.AsT0;
+        return field.IsPointer
+            ? Model.Type.Pointer
+            : Model.ComplexType.GetFullyQualified(type);
+    }
+
+    private static string SetExpression(GirModel.Record record, GirModel.Field field)
+    {
+        return $"Handle.Set{Model.Field.GetName(field)}(value)";
+    }
+
+    private static string GetExpression(GirModel.Record record, GirModel.Field field)
+    {
+        return $"Handle.Get{Model.Field.GetName(field)}()";
+    }
+}
diff --git a/src/Generation/Generator/Renderer/Public/Field/Converter/PrimitiveValueType.cs b/src/Generation/Generator/Renderer/Public/Field/Converter/PrimitiveValueType.cs
@@ -0,0 +1,36 @@
+namespace Generator.Renderer.Public.Field;
+
+internal class PrimitiveValueType : FieldConverter
+{
+    public bool Supports(GirModel.Field field)
+    {
+        return field.AnyTypeOrCallback.TryPickT0(out var anyType, out _) && anyType.Is<GirModel.PrimitiveValueType>();
+    }
+
+    public RenderableField Convert(GirModel.Field field)
+    {
+        return new RenderableField(
+            Name: Model.Field.GetName(field),
+            NullableTypeName: GetNullableTypeName(field),
+            SetExpression: SetExpression,
+            GetExpression: GetExpression
+        );
+    }
+
+    private static string GetNullableTypeName(GirModel.Field field)
+    {
+        return field.IsPointer
+            ? Model.Type.Pointer
+            : Model.Type.GetName(field.AnyTypeOrCallback.AsT0.AsT0);
+    }
+
+    private static string SetExpression(GirModel.Record record, GirModel.Field field)
+    {
+        return $"Handle.Set{Model.Field.GetName(field)}(value)";
+    }
+
+    private static string GetExpression(GirModel.Record record, GirModel.Field field)
+    {
+        return $"Handle.Get{Model.Field.GetName(field)}()";
+    }
+}
diff --git a/src/Generation/Generator/Renderer/Public/Field/Converter/String.cs b/src/Generation/Generator/Renderer/Public/Field/Converter/String.cs
@@ -0,0 +1,33 @@
+using Generator.Model;
+
+namespace Generator.Renderer.Public.Field;
+
+internal class String : FieldConverter
+{
+    public bool Supports(GirModel.Field field)
+    {
+        return field.AnyTypeOrCallback.TryPickT0(out var anyType, out _) && anyType.Is<GirModel.String>();
+    }
+
+    public RenderableField Convert(GirModel.Field field)
+    {
+        //Struct fields are always nullable as there are no information on nullability
+
+        return new RenderableField(
+            Name: Model.Field.GetName(field),
+            NullableTypeName: $"{Type.GetName(field.AnyTypeOrCallback.AsT0.AsT0)}?",
+            SetExpression: SetExpression,
+            GetExpression: GetExpression
+        );
+    }
+
+    private static string SetExpression(GirModel.Record record, GirModel.Field field)
+    {
+        return $"Handle.Set{Model.Field.GetName(field)}(GLib.Internal.StringHelper.StringToPtrUtf8(value))";
+    }
+
+    private static string GetExpression(GirModel.Record record, GirModel.Field field)
+    {
+        return $"Marshal.PtrToStringUTF8(Handle.Get{Model.Field.GetName(field)}())";
+    }
+}
diff --git a/src/Generation/Generator/Renderer/Public/Field/FieldConverter.cs b/src/Generation/Generator/Renderer/Public/Field/FieldConverter.cs
@@ -0,0 +1,7 @@
+namespace Generator.Renderer.Public.Field;
+
+public interface FieldConverter
+{
+    bool Supports(GirModel.Field field);
+    RenderableField Convert(GirModel.Field field);
+}
diff --git a/src/Generation/Generator/Renderer/Public/Field/Fields.cs b/src/Generation/Generator/Renderer/Public/Field/Fields.cs
@@ -0,0 +1,23 @@
+using System.Collections.Generic;
+
+namespace Generator.Renderer.Public;
+
+internal static class Fields
+{
+    private static readonly List<Field.FieldConverter> Converters = new()
+    {
+        new Field.Bitfield(),
+        new Field.Enumeration(),
+        new Field.PrimitiveValueType(),
+        new Field.String(),
+    };
+
+    public static Field.RenderableField GetRenderableField(GirModel.Field field)
+    {
+        foreach (var converter in Converters)
+            if (converter.Supports(field))
+                return converter.Convert(field);
+
+        throw new System.Exception($"Internal field \"{field.Name}\" of type {field.AnyTypeOrCallback} can not be rendered");
+    }
+}
diff --git a/src/Generation/Generator/Renderer/Public/Field/RenderableField.cs b/src/Generation/Generator/Renderer/Public/Field/RenderableField.cs
@@ -0,0 +1,7 @@
+using System;
+
+namespace Generator.Renderer.Public.Field;
+
+public delegate string Expression(GirModel.Record record, GirModel.Field field);
+
+public record RenderableField(string Name, string NullableTypeName, Expression SetExpression, Expression GetExpression);
diff --git a/src/Generation/Generator/Renderer/Public/TypedRecord.cs b/src/Generation/Generator/Renderer/Public/TypedRecord.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Linq;
+using System.Text;
 using Generator.Model;
 
 namespace Generator.Renderer.Public;
@@ -49,6 +50,10 @@ public partial class {name}
 
     {FunctionRenderer.Render(record.TypeFunction)}
 
+    {record.Fields
+        .Select(f => RenderField(record, f))
+        .Join(Environment.NewLine)}
+
     {record.Functions
         .Select(FunctionRenderer.Render)
         .Join(Environment.NewLine)}
@@ -59,4 +64,34 @@ public partial class {name}
         .Join(Environment.NewLine)}
 }}";
     }
+
+    private static string RenderField(GirModel.Record record, GirModel.Field field)
+    {
+        try
+        {
+            var renderableField = Fields.GetRenderableField(field);
+
+            if (field is { IsReadable: false, IsWritable: false } || field.IsPrivate)
+                return string.Empty;
+
+            var result = new StringBuilder();
+
+            result.AppendLine($"public {renderableField.NullableTypeName} {renderableField.Name} {{");
+
+            if (field.IsReadable)
+                result.AppendLine($"get => {renderableField.GetExpression(record, field)};");
+
+            if (field.IsWritable)
+                result.AppendLine($"set => {renderableField.SetExpression(record, field)};");
+
+            result.AppendLine("}");
+
+            return result.ToString();
+        }
+        catch (Exception ex)
+        {
+            Log.Warning($"Did not render typed record {record.Name} field {field.Name}: {ex.Message}");
+            return string.Empty;
+        }
+    }
 }
diff --git a/src/Libs/GLib-2.0/Public/GException.cs b/src/Libs/GLib-2.0/Public/GException.cs
@@ -8,9 +8,8 @@ public sealed class GException : Exception, IDisposable
     private readonly Internal.ErrorHandle _errorHandle;
 
     public GException(Internal.ErrorHandle errorHandle)
-        : base(Marshal.PtrToStructure<Internal.ErrorData>(errorHandle.DangerousGetHandle()).Message)
+        : base(Marshal.PtrToStringUTF8(errorHandle.GetMessage()))
     {
-
         _errorHandle = errorHandle;
     }
 

diff --git a/src/Native/GirTestLib/girtest-typed-record-tester.c b/src/Native/GirTestLib/girtest-typed-record-tester.c
@@ -13,6 +13,7 @@ girtest_typed_record_tester_new ()
     GirTestTypedRecordTester *result;
     result = g_new0 (GirTestTypedRecordTester, 1);
     result->ref_count = 1;
+    result->custom_string = g_strdup("Hello");
     return result;
 }
 
@@ -113,6 +114,7 @@ girtest_typed_record_tester_unref (GirTestTypedRecordTester *self)
     if (self->ref_count > 0)
         return;
 
+    g_free(self->custom_string);
     g_free (self);
 }
 

diff --git a/src/Native/GirTestLib/girtest-typed-record-tester.h b/src/Native/GirTestLib/girtest-typed-record-tester.h
@@ -4,6 +4,30 @@
 
 G_BEGIN_DECLS
 
+/**
+ * GirTestTypedRecordTesterEnum:
+ * @A: 1
+ * @B: 2
+ *
+ * Enum to test bindings.
+ */
+typedef enum {
+    TYPED_RECORD_TESTER_ENUM_A = 0,
+    TYPED_RECORD_TESTER_ENUM_B = 1
+} GirTestTypedRecordTesterEnum;
+
+/**
+ * GirTestTypedRecordTesterBitfield:
+ * @ZERO: No flags set.
+ * @ONE: Set first flag.
+ *
+ * Flags to test bindings.
+ */
+typedef enum {
+    TYPED_RECORD_TESTER_ZERO = 0,
+    TYPED_RECORD_TESTER_ONE  = (1 << 0)
+} GirTestTypedRecordTesterBitfield;
+
 /**
  * GirTestTypedRecordTester:
  *
@@ -12,6 +36,11 @@ G_BEGIN_DECLS
 struct _GirTestTypedRecordTester
 {
     int ref_count;
+    GirTestTypedRecordTesterEnum custom_enum;
+    GirTestTypedRecordTesterBitfield custom_bitfield;
+    gchar* custom_string;
+    /* < private > */
+    int custom_int_private;
 };
 
 typedef struct _GirTestTypedRecordTester GirTestTypedRecordTester;