gircore · badcel · Feb 25, 2025 · Feb 13, 2025 · Feb 13, 2025 · Feb 15, 2025
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -127,7 +127,7 @@ jobs:
           shell: bash
 
       - name: Verify code format
-        run: dotnet format GirCore.sln --no-restore --verify-no-changes --exclude *.Generated.cs
+        run: dotnet format GirCore.sln --no-restore --verify-no-changes --exclude *.Generated.cs --exclude-diagnostics GirCore1001 GirCore1002 GirCore1003
         working-directory: './src'
 
       - name: Run integration tests

diff --git a/docs/docs/integration/diagnostic/1001.md b/docs/docs/integration/diagnostic/1001.md
@@ -0,0 +1,30 @@
+# GirCore1001
+
+- Title: GObject subclass constructor with parameters must call 'this()' constructor
+- Message: GObject subclass constructor with parameters must call a generated constructor like 'this()'
+
+Not calling the `this` results in the class being represented by its parent type instead of its actual type. Call `this()` to ensure the correct type of the instance.
+
+Invalid code:
+```csharp
+[Subclass<Gtk.Widget>]
+public partial class MyWidget
+{
+    public MyWidget(string data)
+    {
+        ...
+    }
+}
+```
+
+Solution:
+```csharp
+[Subclass<Gtk.Widget>]
+public partial class MyWidget
+{
+    public MyWidget(string data) : this()
+    {
+        ...
+    }
+}
+```
diff --git a/docs/docs/integration/diagnostic/1002.md b/docs/docs/integration/diagnostic/1002.md
@@ -0,0 +1,30 @@
+# GirCore1002
+
+- Title: GObject subclass constructor without parameters must use partial 'Initialize' method
+- Message: GObject subclass constructor without parameters must use 'partial void Initialize()' method instead of a constructor
+
+Using a custom constructor instead of the `Initialize()` method does not initialize the instance in all cases. There are generated constructors which can get called if a new instance is created by native code. Those constructors call the `Initialize()` method.
+
+Invalid code:
+```csharp
+[Subclass<Gtk.Widget>]
+public partial class MyWidget
+{
+    public MyWidget()
+    {
+        ...
+    }
+}
+```
+
+Solution:
+```csharp
+[Subclass<Gtk.Widget>]
+public partial class MyWidget
+{
+    partial void Initialize()
+    {
+        ...
+    }
+}
+```
diff --git a/docs/docs/integration/diagnostic/1003.md b/docs/docs/integration/diagnostic/1003.md
@@ -0,0 +1,30 @@
+# GirCore1001
+
+- Title: GObject subclass constructor must not call base constructor
+- Message: GObject subclass constructor must call a generated constructor like 'this()' instead of 'base()'
+
+An explicit call to the constructor of a base class results in an instance which has the type of its parent instead of its own type. Call `this()` to ensure the correct type of the instance.
+
+Invalid code:
+```csharp
+[Subclass<Gtk.Widget>]
+public partial class MyWidget
+{
+    public MyWidget(string text) : base()
+    {
+        ...
+    }
+}
+```
+
+Solution:
+```csharp
+[Subclass<Gtk.Widget>]
+public partial class MyWidget
+{
+    public MyWidget(string text) : this()
+    {
+        ...
+    }
+}
+```
diff --git a/docs/docs/integration/index.md b/docs/docs/integration/index.md
@@ -0,0 +1,11 @@
+# Integration packages
+
+The GirCore project provides integration nuget packages which can generate boilerplate code to allow easy integration of dotnet with the GObject type system.
+
+The following nuget packages are available:
+- [GObject-2.0.Integration](https://www.nuget.org/packages/GirCore.GObject-2.0.Integration): Makes it easy to create a subclass of a GObject 
+
+## Diagnostic messages
+- [GirCore1001](diagnostic/1001.md)
+- [GirCore1002](diagnostic/1002.md)
+- [GirCore1003](diagnostic/1003.md)
diff --git a/src/Extensions/GObject-2.0.Integration/Attributes/GeneratedCodeAttribute.cs b/src/Extensions/GObject-2.0.Integration/Attributes/GeneratedCodeAttribute.cs
@@ -0,0 +1,33 @@
+using System;
+using System.Reflection;
+
+namespace GObject.Integration;
+
+internal static class GeneratedCodeAttribute
+{
+    private static string Version { get; } = GetVersion();
+    private static string Name { get; } = GetName();
+
+    public static string Render()
+    {
+        return $"""[System.CodeDom.Compiler.GeneratedCode("{Name}", "{Version}")]""";
+    }
+
+    private static string GetName()
+    {
+        var name = Assembly.GetExecutingAssembly().GetName().Name;
+        if (name is null)
+            throw new NotSupportedException("Could not get assembly version");
+
+        return $"GirCore.{name}";
+    }
+
+    private static string GetVersion()
+    {
+        var version = Assembly.GetExecutingAssembly().GetName().Version;
+        if (version is null)
+            throw new NotSupportedException("Could not get assembly version");
+
+        return $"{version.Major}.{version.Minor}.{version.Build}";
+    }
+}
diff --git a/src/Extensions/GObject-2.0.Integration/Attributes/HandleAttribute.cs b/src/Extensions/GObject-2.0.Integration/Attributes/HandleAttribute.cs
@@ -0,0 +1,14 @@
+using Microsoft.CodeAnalysis;
+
+namespace GObject.Integration;
+
+internal static class HandleAttribute
+{
+    private const string FullyQualifiedDisplayName = "global::GObject.HandleAttribute<T>";
+
+    public static bool IsHandleAttribute(this AttributeData data)
+    {
+        var displayString = data.AttributeClass?.OriginalDefinition.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat);
+        return displayString == FullyQualifiedDisplayName;
+    }
+}
diff --git a/src/Extensions/GObject-2.0.Integration/Attributes/SubclassAttribute.cs b/src/Extensions/GObject-2.0.Integration/Attributes/SubclassAttribute.cs
@@ -0,0 +1,15 @@
+using Microsoft.CodeAnalysis;
+
+namespace GObject.Integration;
+
+internal static class SubclassAttribute
+{
+    public const string MetadataName = "GObject.SubclassAttribute`1";
+    public const string FullyQualifiedDisplayName = "global::GObject.SubclassAttribute<T>";
+
+    public static bool IsSubclassAttribute(this AttributeData data)
+    {
+        var displayString = data.AttributeClass?.OriginalDefinition.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat);
+        return displayString == FullyQualifiedDisplayName;
+    }
+}
diff --git a/src/Extensions/GObject-2.0.Integration/GObject-2.0.Integration.csproj b/src/Extensions/GObject-2.0.Integration/GObject-2.0.Integration.csproj
@@ -25,6 +25,7 @@
     <ItemGroup>
         <!-- Reference 4.8 as it is the first version which supports net8.0 -->
         <PackageReference Include="Microsoft.CodeAnalysis.Common" Version="4.8.0"/>
+        <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0"/>
     </ItemGroup>
 
     <ItemGroup>

diff --git a/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/Analyzer.cs b/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/Analyzer.cs
@@ -0,0 +1,31 @@
+using System.Collections.Immutable;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.Diagnostics;
+
+namespace GObject.Integration.SourceAnalyzer;
+
+[DiagnosticAnalyzer(LanguageNames.CSharp)]
+public class Analyzer : DiagnosticAnalyzer
+{
+
+    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = [
+        GirCore1001.DiagnosticDescriptor,
+        GirCore1002.DiagnosticDescriptor,
+        GirCore1003.DiagnosticDescriptor
+    ];
+
+    public override void Initialize(AnalysisContext context)
+    {
+        context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
+        context.EnableConcurrentExecution();
+
+        RegisterDiagnosticRule<GirCore1001>(context);
+        RegisterDiagnosticRule<GirCore1002>(context);
+        RegisterDiagnosticRule<GirCore1003>(context);
+    }
+
+    private static void RegisterDiagnosticRule<T>(AnalysisContext context) where T : Rule
+    {
+        context.RegisterSyntaxNodeAction(T.Analyze, T.SyntaxKind);
+    }
+}
diff --git a/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/DiagnosticLink.cs b/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/DiagnosticLink.cs
@@ -0,0 +1,9 @@
+namespace GObject.Integration.SourceAnalyzer;
+
+internal static class DiagnosticLink
+{
+    public static string Create(int id)
+    {
+        return $"https://gircore.github.io/docs/integration/diagnostic/{id}.html";
+    }
+}
diff --git a/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/Rules/GirCore1001.cs b/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/Rules/GirCore1001.cs
@@ -0,0 +1,45 @@
+using System.Linq;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+using Microsoft.CodeAnalysis.Diagnostics;
+
+namespace GObject.Integration.SourceAnalyzer;
+
+internal sealed class GirCore1001 : Rule
+{
+    public static SyntaxKind SyntaxKind => SyntaxKind.ConstructorDeclaration;
+
+    public static DiagnosticDescriptor DiagnosticDescriptor { get; } = new(
+        id: "GirCore1001",
+        title: "GObject subclass constructor with parameters must call 'this()' constructor",
+        messageFormat: "GObject subclass constructor with parameters must call a generated constructor like 'this()'",
+        category: "Usage",
+        defaultSeverity: DiagnosticSeverity.Warning,
+        isEnabledByDefault: true,
+        helpLinkUri: DiagnosticLink.Create(1001)
+    );
+
+    public static void Analyze(SyntaxNodeAnalysisContext context)
+    {
+        var constructorSyntax = (ConstructorDeclarationSyntax) context.Node;
+
+        if (!constructorSyntax.ParameterList.Parameters.Any())
+            return;
+
+        var initializerSyntax = constructorSyntax.Initializer;
+
+        if (initializerSyntax is not null)
+            return;
+
+        if (constructorSyntax.Parent is not ClassDeclarationSyntax classSyntax)
+            return;
+
+        var classSymbol = context.SemanticModel.GetDeclaredSymbol(classSyntax);
+        if (classSymbol is null || !classSymbol.GetAttributes().Any(x => x.IsSubclassAttribute()))
+            return;
+
+        var diagnostic = Diagnostic.Create(DiagnosticDescriptor, constructorSyntax.Identifier.GetLocation());
+        context.ReportDiagnostic(diagnostic);
+    }
+}
diff --git a/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/Rules/GirCore1002.cs b/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/Rules/GirCore1002.cs
@@ -0,0 +1,40 @@
+using System.Linq;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+using Microsoft.CodeAnalysis.Diagnostics;
+
+namespace GObject.Integration.SourceAnalyzer;
+
+internal sealed class GirCore1002 : Rule
+{
+    public static SyntaxKind SyntaxKind => SyntaxKind.ConstructorDeclaration;
+
+    public static DiagnosticDescriptor DiagnosticDescriptor { get; } = new(
+        id: "GirCore1002",
+        title: "GObject subclass constructor without parameters must use partial 'Initialize' method",
+        messageFormat: "GObject subclass constructor without parameters must use 'partial void Initialize()' method instead of a constructor",
+        category: "Usage",
+        defaultSeverity: DiagnosticSeverity.Warning,
+        isEnabledByDefault: true,
+        helpLinkUri: DiagnosticLink.Create(1002)
+    );
+
+    public static void Analyze(SyntaxNodeAnalysisContext context)
+    {
+        var constructorSyntax = (ConstructorDeclarationSyntax) context.Node;
+
+        if (constructorSyntax.ParameterList.Parameters.Any())
+            return;
+
+        if (constructorSyntax.Parent is not ClassDeclarationSyntax classSyntax)
+            return;
+
+        var classSymbol = context.SemanticModel.GetDeclaredSymbol(classSyntax);
+        if (classSymbol is null || !classSymbol.GetAttributes().Any(x => x.IsSubclassAttribute()))
+            return;
+
+        var diagnostic = Diagnostic.Create(DiagnosticDescriptor, constructorSyntax.Identifier.GetLocation());
+        context.ReportDiagnostic(diagnostic);
+    }
+}
diff --git a/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/Rules/GirCore1003.cs b/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/Rules/GirCore1003.cs
@@ -0,0 +1,41 @@
+using System.Linq;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+using Microsoft.CodeAnalysis.Diagnostics;
+
+namespace GObject.Integration.SourceAnalyzer;
+
+internal sealed class GirCore1003 : Rule
+{
+    public static SyntaxKind SyntaxKind => SyntaxKind.ConstructorDeclaration;
+
+    public static DiagnosticDescriptor DiagnosticDescriptor { get; } = new(
+        id: "GirCore1003",
+        title: "GObject subclass constructor must not call base constructor",
+        messageFormat: "GObject subclass constructor must call a generated constructor like 'this()' instead of 'base()'",
+        category: "Usage",
+        defaultSeverity: DiagnosticSeverity.Warning,
+        isEnabledByDefault: true,
+        helpLinkUri: DiagnosticLink.Create(1003)
+    );
+
+    public static void Analyze(SyntaxNodeAnalysisContext context)
+    {
+        var constructorSyntax = (ConstructorDeclarationSyntax) context.Node;
+        var initializerSyntax = constructorSyntax.Initializer;
+
+        if (initializerSyntax is null || initializerSyntax.Kind() != SyntaxKind.BaseConstructorInitializer)
+            return;
+
+        if (constructorSyntax.Parent is not ClassDeclarationSyntax classSyntax)
+            return;
+
+        var classSymbol = context.SemanticModel.GetDeclaredSymbol(classSyntax);
+        if (classSymbol is null || !classSymbol.GetAttributes().Any(x => x.IsSubclassAttribute()))
+            return;
+
+        var diagnostic = Diagnostic.Create(DiagnosticDescriptor, initializerSyntax.GetLocation());
+        context.ReportDiagnostic(diagnostic);
+    }
+}
diff --git a/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/Rules/Rule.cs b/src/Extensions/GObject-2.0.Integration/SourceAnalyzer/Rules/Rule.cs
@@ -0,0 +1,10 @@
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.Diagnostics;
+
+namespace GObject.Integration.SourceAnalyzer;
+
+internal interface Rule
+{
+    static abstract SyntaxKind SyntaxKind { get; }
+    static abstract void Analyze(SyntaxNodeAnalysisContext context);
+}