Merge pull request #4 from xSeagullx/support-base-interfaces

PhilSA · web-flow · commit 6ee22963b625 · 2022-07-04T09:22:21.000-04:00
Improvements to structs generation.
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/.gitignore b/SourceGenerators/PolymorphicStructsSourceGenerators/.gitignore
@@ -0,0 +1,4 @@
+/.idea
+
+!*.sln
+!*.csproj
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators.sln b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators.sln
@@ -3,23 +3,30 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.0.31919.166
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PolymorphicStructsSourceGenerators", "PolymorphicStructsSourceGenerators\PolymorphicStructsSourceGenerators.csproj", "{454B6834-A6FC-432C-A3EF-702EFA899A7F}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PolymorphicStructsSourceGeneratorsTests", "PolymorphicStructsSourceGeneratorsTests\PolymorphicStructsSourceGeneratorsTests.csproj", "{747A1BAC-DB40-4AC7-A888-3A6BA9B37AD9}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PolymorphicStructsSourceGenerators", "PolymorphicStructsSourceGenerators\PolymorphicStructsSourceGenerators.csproj", "{C448E748-E4B8-4824-9245-CEC42CF5F6BE}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{454B6834-A6FC-432C-A3EF-702EFA899A7F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{454B6834-A6FC-432C-A3EF-702EFA899A7F}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{454B6834-A6FC-432C-A3EF-702EFA899A7F}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{454B6834-A6FC-432C-A3EF-702EFA899A7F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C2C9894F-E4B7-4B82-B6E9-5135577E2767}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C2C9894F-E4B7-4B82-B6E9-5135577E2767}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C2C9894F-E4B7-4B82-B6E9-5135577E2767}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C2C9894F-E4B7-4B82-B6E9-5135577E2767}.Release|Any CPU.Build.0 = Release|Any CPU
+		{747A1BAC-DB40-4AC7-A888-3A6BA9B37AD9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{747A1BAC-DB40-4AC7-A888-3A6BA9B37AD9}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{747A1BAC-DB40-4AC7-A888-3A6BA9B37AD9}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{747A1BAC-DB40-4AC7-A888-3A6BA9B37AD9}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C448E748-E4B8-4824-9245-CEC42CF5F6BE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C448E748-E4B8-4824-9245-CEC42CF5F6BE}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C448E748-E4B8-4824-9245-CEC42CF5F6BE}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C448E748-E4B8-4824-9245-CEC42CF5F6BE}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
-	GlobalSection(ExtensibilityGlobals) = postSolution
-		SolutionGuid = {C2E19360-9CA5-4957-AB7F-28876225DC27}
-	EndGlobalSection
 EndGlobal
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerator.cs b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerator.cs
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators.csproj b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators.csproj
@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>netstandard2.0</TargetFramework>
+        <RootNamespace>PolymorphicStructsSourceGenerators</RootNamespace>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Microsoft.CodeAnalysis" Version="3.8.0" />
+    </ItemGroup>
+
+</Project>
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators/SourceGenUtils.cs b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators/SourceGenUtils.cs
@@ -6,6 +6,7 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+// ReSharper disable HeapView.BoxingAllocation
 
 namespace PolymorphicStructsSourceGenerators
 {
@@ -96,5 +97,23 @@ public static string GetNamespace(BaseTypeDeclarationSyntax syntax)
 
             return nameSpace;
         }
+
+        public static List<ISymbol> GetAllMemberSymbols(GeneratorExecutionContext context, InterfaceDeclarationSyntax polymorphicInterface)
+        {
+            var semanticModel = context.Compilation.GetSemanticModel(polymorphicInterface.SyntaxTree);
+            var interfaceSymbol = semanticModel.GetDeclaredSymbol(polymorphicInterface, context.CancellationToken);
+
+            return interfaceSymbol?.GetMembers().Concat(interfaceSymbol
+                    ?.AllInterfaces
+                    .SelectMany(it => it.GetMembers()))
+                .Where(IsNotAPropertyMethod)
+                .ToList();
+        }
+
+        private static bool IsNotAPropertyMethod(ISymbol it)
+        {
+            return !(it is IMethodSymbol methodSymbol) || methodSymbol.MethodKind != MethodKind.PropertyGet &&
+                methodSymbol.MethodKind != MethodKind.PropertySet;
+        }
     }
 }
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators/bin/Release/netstandard2.0/PolymorphicStructsSourceGenerators.dll b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGenerators/bin/Release/netstandard2.0/PolymorphicStructsSourceGenerators.dll
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/PolymorphicStruct.cs b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/PolymorphicStruct.cs
@@ -0,0 +1,19 @@
+﻿using System;
+
+namespace PolymorphicStructsSourceGeneratorsTests
+{
+/// <summary>
+/// We can use our own polymorphic struct argument so we don't have to reference anything else
+/// Generator resolves attribute by name, so as long as it matches, we don't care where it's coming from
+/// </summary>
+[AttributeUsage(AttributeTargets.Interface)]
+public class PolymorphicStruct : System.Attribute
+{
+    public string ImplementedInterfaces;
+
+    public PolymorphicStruct(string implementedInterfaces = "")
+    {
+        ImplementedInterfaces = implementedInterfaces;
+    }
+}
+}
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/PolymorphicStructsSourceGeneratorsTests.csproj b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/PolymorphicStructsSourceGeneratorsTests.csproj
@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>net5.0</TargetFramework>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.2.0" />
+        <PackageReference Include="NUnit" Version="3.13.3" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\PolymorphicStructsSourceGenerators\PolymorphicStructsSourceGenerators.csproj" OutputItemType="Analyzer" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <Folder Include="Inheritance" />
+    </ItemGroup>
+
+</Project>
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/FieldsTest.cs b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/FieldsTest.cs
@@ -0,0 +1,55 @@
+﻿using System.Diagnostics.CodeAnalysis;
+using NUnit.Framework;
+
+namespace PolymorphicStructsSourceGeneratorsTests.Tests
+{
+[PolymorphicStruct]
+public interface IFieldTestStruct
+{
+    public int Foo();
+}
+
+public partial struct FieldTestStruct {
+}
+
+
+public partial struct FieldTestStructA : IFieldTestStruct
+{
+    public int Field;
+
+    public int Foo()
+    {
+        return Field;
+    }
+}
+
+public partial struct FieldTestStructB : IFieldTestStruct
+{
+    public int Field;
+    public int Field2;
+
+    public int Foo()
+    {
+        return Field + Field2;
+    }
+}
+
+
+[TestFixture]
+[SuppressMessage("ReSharper", "HeapView.BoxingAllocation")]
+public partial class FieldsTest
+{
+    [Test]
+    public void PolymoprphicStructWorks()
+    {
+        var baseStructA = new FieldTestStructA { Field = 1 }.ToFieldTestStruct();
+        var baseStructB = new FieldTestStructB { Field = 2, Field2 = 3 }.ToFieldTestStruct();
+
+        Assert.AreEqual(FieldTestStruct.TypeId.FieldTestStructA, baseStructA.CurrentTypeId);
+        Assert.AreEqual(FieldTestStruct.TypeId.FieldTestStructB, baseStructB.CurrentTypeId);
+        
+        Assert.AreEqual(1, baseStructA.Foo());
+        Assert.AreEqual(5, baseStructB.Foo());
+    }
+}
+}
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/InterfaceHierarchyTest.cs b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/InterfaceHierarchyTest.cs
@@ -0,0 +1,53 @@
+﻿using System.Diagnostics.CodeAnalysis;
+using NUnit.Framework;
+
+namespace PolymorphicStructsSourceGeneratorsTests.Tests
+{
+public interface IParentStruct
+{
+    public int Foo(int a, bool b);
+}
+
+public interface IParentStruct2
+{
+    public int Bar();
+}
+
+[PolymorphicStruct]
+public interface IChildStruct : IParentStruct, IParentStruct2
+{ }
+
+public partial struct ChildStruct : IChildStruct
+    // an ability to explicitly define IChildStruct here is redundant, if generated ChildStruct will be always implementing IChildStruct.
+    // But you might still want to do that and also define other interfaces, which should not affect generation
+    // Also, if you did that by mistake, now generator won't be including it in the TypeId
+{
+}
+
+public partial struct InheritedStruct : IChildStruct
+{
+    public int Foo(int a, bool b)
+    {
+        return 42 + a * (b ? 1 : 0);
+    }
+
+    public int Bar()
+    {
+        return 13;
+    }
+}
+
+[TestFixture]
+[SuppressMessage("ReSharper", "HeapView.BoxingAllocation")]
+public partial class InheritanceHierarchyTest
+{
+    [Test]
+    public void GeneratedStructureContainsMethodsFromBaseInterfaces()
+    {
+        var childStruct = new InheritedStruct().ToChildStruct();
+        Assert.AreEqual(13, childStruct.Bar());
+        Assert.AreEqual(42, childStruct.Foo(1, false));
+        Assert.AreEqual(43, childStruct.Foo(1, true));
+    }
+}
+}
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/MethodParametersTests.cs b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/MethodParametersTests.cs
@@ -0,0 +1,68 @@
+﻿using System.Diagnostics.CodeAnalysis;
+using NUnit.Framework;
+
+namespace PolymorphicStructsSourceGeneratorsTests.Tests
+{
+public struct MethodParamTestStruct
+{
+    public int Field;
+}
+
+[PolymorphicStruct]
+public interface IMethodParametersStruct
+{
+    public struct MyInnerStruct
+    {
+        public int Field;
+    }
+
+    public void Foo1(); // void no arg
+    public int Foo2(); // return value, no arg
+    public int Foo3(int a); // One arg
+
+    public void Foo4(ref IMethodParametersStruct.MyInnerStruct a, in MethodParamTestStruct b,
+        out MethodParamTestStruct c); // yolo
+}
+
+public partial struct MethodParametersStructA : IMethodParametersStruct
+{
+    public void Foo1()
+    {
+    }
+
+    public int Foo2()
+    {
+        return 1;
+    }
+
+    public int Foo3(int a)
+    {
+        return a;
+    }
+
+    public void Foo4(ref IMethodParametersStruct.MyInnerStruct a, in MethodParamTestStruct b, out MethodParamTestStruct c)
+    {
+        a.Field = b.Field;
+        c = new MethodParamTestStruct { Field = 42 };
+    }
+}
+
+[TestFixture]
+[SuppressMessage("ReSharper", "HeapView.BoxingAllocation")]
+public partial class MethodParametersTests
+{
+    [Test]
+    public void GeneratedStructureImplementsInterfaceSimple()
+    {
+        var myStruct = new MethodParametersStructA().ToMethodParametersStruct();
+
+        Assert.DoesNotThrow(() => myStruct.Foo1());
+        Assert.AreEqual(1, myStruct.Foo2());
+        Assert.AreEqual(5, myStruct.Foo3(5));
+        var innerStruct = new IMethodParametersStruct.MyInnerStruct { Field = 5 };
+        myStruct.Foo4(ref innerStruct, new MethodParamTestStruct { Field = 43 }, out var outStruct);
+        Assert.AreEqual(43, innerStruct.Field, "ref works");
+        Assert.AreEqual(42, outStruct.Field, "out works");
+    }
+}
+}
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/MultipleHierarchies.cs b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/MultipleHierarchies.cs
@@ -0,0 +1,56 @@
+﻿using System.Diagnostics.CodeAnalysis;
+using NUnit.Framework;
+
+namespace PolymorphicStructsSourceGeneratorsTests.Tests
+{
+
+public interface IAction
+{
+    int Act();
+}
+
+[PolymorphicStruct]
+public interface IMelleEnemyAction : IAction
+{
+    
+}
+
+[PolymorphicStruct]
+public interface IRangedEnemyAction : IAction
+{
+    
+}
+
+public partial struct MeleeIdleAction : IMelleEnemyAction
+{
+    public int Act()
+    {
+        return 1;
+    }
+}
+
+public partial struct RangedIdleAction : IRangedEnemyAction
+{
+    public int Act()
+    {
+        return 2;
+    }
+}
+
+[TestFixture]
+[SuppressMessage("ReSharper", "HeapView.BoxingAllocation")]
+public class MultipleHierarchiesTest
+{
+    [Test]
+    public void CanHaveIndependentHierarchiesShareCommonCode()
+    {
+        Assert.AreEqual(1, ActionCommonCode(new MeleeIdleAction().ToMelleEnemyAction()));
+        Assert.AreEqual(2, ActionCommonCode(new RangedIdleAction().ToRangedEnemyAction()));
+    }
+
+    private static int ActionCommonCode<T>(T action) where T : struct, IAction
+    {
+        return action.Act(); // here I can call anything that parent interface defines
+    }
+}
+}
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/PropertiesTest.cs b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/PropertiesTest.cs
diff --git a/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/SimpleInterfaceTest.cs b/SourceGenerators/PolymorphicStructsSourceGenerators/PolymorphicStructsSourceGeneratorsTests/Tests/SimpleInterfaceTest.cs

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +/.idea
++
 +!*.sln
 +!*.csproj