Merge pull request #82918 from raulsntos/dotnet/only-node-can-export-…

…node C#: Report diagnostic for Node exports in a type that doesn't derive from Node
godotengine · Oct 27, 2023 · bf41c6b · bf41c6b
2 parents d88ef22 + bfe1a93
commit bf41c6b
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 1 deletion.
diff --git a/modules/mono/editor/Godot.NET.Sdk/Godot.SourceGenerators/Common.cs b/modules/mono/editor/Godot.NET.Sdk/Godot.SourceGenerators/Common.cs
@@ -230,6 +230,31 @@ ISymbol exportedMemberSymbol
                 location?.SourceTree?.FilePath));
         }
 
+        public static void ReportOnlyNodesShouldExportNodes(
+            GeneratorExecutionContext context,
+            ISymbol exportedMemberSymbol
+        )
+        {
+            var locations = exportedMemberSymbol.Locations;
+            var location = locations.FirstOrDefault(l => l.SourceTree != null) ?? locations.FirstOrDefault();
+            bool isField = exportedMemberSymbol is IFieldSymbol;
+
+            string message = $"Types not derived from Node should not export Node {(isField ? "fields" : "properties")}";
+
+            string description = $"{message}. Node export is only supported in Node-derived classes.";
+
+            context.ReportDiagnostic(Diagnostic.Create(
+                new DiagnosticDescriptor(id: "GD0107",
+                    title: message,
+                    messageFormat: message,
+                    category: "Usage",
+                    DiagnosticSeverity.Error,
+                    isEnabledByDefault: true,
+                    description),
+                location,
+                location?.SourceTree?.FilePath));
+        }
+
         public static void ReportSignalDelegateMissingSuffix(
             GeneratorExecutionContext context,
             INamedTypeSymbol delegateSymbol)

diff --git a/modules/mono/editor/Godot.NET.Sdk/Godot.SourceGenerators/ExtensionMethods.cs b/modules/mono/editor/Godot.NET.Sdk/Godot.SourceGenerators/ExtensionMethods.cs
@@ -32,7 +32,7 @@ public static bool IsGodotSourceGeneratorDisabled(this GeneratorExecutionContext
             disabledGenerators != null &&
             disabledGenerators.Split(';').Contains(generatorName));
 
-        public static bool InheritsFrom(this INamedTypeSymbol? symbol, string assemblyName, string typeFullName)
+        public static bool InheritsFrom(this ITypeSymbol? symbol, string assemblyName, string typeFullName)
         {
             while (symbol != null)
             {

diff --git a/modules/mono/editor/Godot.NET.Sdk/Godot.SourceGenerators/ScriptPropertyDefValGenerator.cs b/modules/mono/editor/Godot.NET.Sdk/Godot.SourceGenerators/ScriptPropertyDefValGenerator.cs
@@ -170,6 +170,15 @@ void AppendPartialContainingTypeDeclarations(INamedTypeSymbol? containingType)
                     continue;
                 }
 
+                if (marshalType == MarshalType.GodotObjectOrDerived)
+                {
+                    if (!symbol.InheritsFrom("GodotSharp", "Godot.Node") &&
+                        propertyType.InheritsFrom("GodotSharp", "Godot.Node"))
+                    {
+                        Common.ReportOnlyNodesShouldExportNodes(context, property);
+                    }
+                }
+
                 var propertyDeclarationSyntax = property.DeclaringSyntaxReferences
                     .Select(r => r.GetSyntax() as PropertyDeclarationSyntax).FirstOrDefault();
 
@@ -265,6 +274,15 @@ void AppendPartialContainingTypeDeclarations(INamedTypeSymbol? containingType)
                     continue;
                 }
 
+                if (marshalType == MarshalType.GodotObjectOrDerived)
+                {
+                    if (!symbol.InheritsFrom("GodotSharp", "Godot.Node") &&
+                        fieldType.InheritsFrom("GodotSharp", "Godot.Node"))
+                    {
+                        Common.ReportOnlyNodesShouldExportNodes(context, field);
+                    }
+                }
+
                 EqualsValueClauseSyntax? initializer = field.DeclaringSyntaxReferences
                     .Select(r => r.GetSyntax())
                     .OfType<VariableDeclaratorSyntax>()