Add Struct Symbols

Author: HurricanKai

Directory.Packages.props

@@ -39,5 +39,6 @@
     <PackageVersion Include="Statiq.Yaml" Version="1.0.0-beta.48" />
     <PackageVersion Include="Humanizer.Core" Version="2.14.1" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.1.0" />
+    <PackageVersion Include="Moq" Version="4.17.2" />
   </ItemGroup>
 </Project>

src/generators/Silk.NET.SilkTouch.Symbols/IdentifierSymbol.cs

@@ -0,0 +1,25 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Silk.NET.SilkTouch.Symbols;
+
+/// <summary>
+/// An Identifier. Generally used to identify another symbol
+/// </summary>
+/// <seealso cref="TypeSymbol"/>
+public sealed class IdentifierSymbol : Symbol
+{
+    /// <summary>
+    /// Create an <see cref="IdentifierSymbol"/> from a string
+    /// </summary>
+    /// <param name="value">The identifier as a string</param>
+    public IdentifierSymbol(string value)
+    {
+        Value = value;
+    }
+
+    /// <summary>
+    /// The Value of this Identifier as a String
+    /// </summary>
+    public string Value { get; }
+}

src/generators/Silk.NET.SilkTouch.Symbols/StructSymbol.cs

@@ -0,0 +1,30 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Silk.NET.SilkTouch.Symbols;
+
+/// <summary>
+/// A <see cref="TypeSymbol"/> representing a <c>struct</c>.
+/// </summary>
+/// <remarks>
+/// In this context, a Struct means a type that represents the layout of a continuous block of memory.
+/// </remarks>
+// /// Each meaningful place in this memory called a field (see <see cref="FieldSymbol"/>) is accessible via this type.
+// /// Fields are allowed to overlap.
+// /// Additionally it may contain one or multiple <see cref="MethodSymbol"/> that are called with an instance of this type as their first argument.
+public sealed class StructSymbol : TypeSymbol
+{
+    /// <summary>
+    /// Creates a struct symbol given it's identifier
+    /// </summary>
+    /// <param name="identifier">The identifier of the struct</param>
+    public StructSymbol(IdentifierSymbol identifier)
+    {
+        Identifier = identifier;
+    }
+        
+    /// <summary>
+    /// The identifier of this struct
+    /// </summary>
+    public override IdentifierSymbol Identifier { get; }
+}

src/generators/Silk.NET.SilkTouch.Symbols/SymbolVisitor.cs

@@ -9,12 +9,56 @@ namespace Silk.NET.SilkTouch.Symbols;
 public abstract class SymbolVisitor
 {
     /// <summary>
-    /// Visit a Symbol. This will call the appropriate method based on the actual type of the <paramref name="symbol"/>
+    /// Visit a <see cref="Symbol"/>. This will call the appropriate method based on the actual type of the <paramref name="symbol"/>
     /// </summary>
     /// <param name="symbol">The symbol to visit</param>
     /// <returns>The rewritten symbol. May be equal to the original symbol of no rewriting has taken place.</returns>
     public virtual Symbol Visit(Symbol symbol)
     {
-        return symbol;
+        if (symbol is TypeSymbol ts) return VisitType(ts);
+
+        return ThrowUnknownSymbol(nameof(Symbol), symbol);
+    }
+
+    /// <summary>
+    /// Visit a <see cref="TypeSymbol"/>. This will call the appropriate method based on the actual type of the <paramref name="typeSymbol"/>
+    /// </summary>
+    /// <param name="typeSymbol">The type symbol to visit</param>
+    /// <returns>The rewritten symbol. May or may not be a <see cref="TypeSymbol"/></returns>
+    /// <seealso cref="VisitStruct"/>
+    protected virtual Symbol VisitType(TypeSymbol typeSymbol)
+    {
+        if (typeSymbol is StructSymbol @struct) return VisitStruct(@struct);
+
+        return ThrowUnknownSymbol(nameof(TypeSymbol), typeSymbol);
+    }
+    
+    /// <summary>
+    /// Visit a <see cref="StructSymbol"/>. Will call the appropriate methods to visit the different parts of the struct.
+    /// </summary>
+    /// <param name="structSymbol">The struct symbol to visit</param>
+    /// <returns>The rewritten symbol. May or may not be a <see cref="StructSymbol"/></returns>
+    /// <seealso cref="VisitType"/>
+    /// <remarks>
+    /// The order in which the parts of the struct are visited is kept as an implementation detail. Do not rely on this order.
+    /// </remarks>
+    protected virtual Symbol VisitStruct(StructSymbol structSymbol)
+    {
+        return new StructSymbol(VisitIdentifier(structSymbol.Identifier));
+    }
+
+    /// <summary>
+    /// Visit an <see cref="IdentifierSymbol"/>.
+    /// </summary>
+    /// <param name="identifierSymbol">The Identifier to Visit</param>
+    /// <returns>The rewritten symbol</returns>
+    protected virtual IdentifierSymbol VisitIdentifier(IdentifierSymbol identifierSymbol)
+    {
+        return identifierSymbol;
+    }
+
+    private static Symbol ThrowUnknownSymbol(string type, Symbol symbol)
+    {
+        throw new NotImplementedException($"Unknown symbol of type {symbol.GetType().FullName} subclass of {type}");
     }
 }

src/generators/Silk.NET.SilkTouch.Symbols/TypeSymbol.cs

@@ -0,0 +1,16 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Silk.NET.SilkTouch.Symbols;
+
+/// <summary>
+/// A generic <see cref="Symbol"/> representing a named type.
+/// </summary>
+/// <seealso cref="StructSymbol"/>
+public abstract class TypeSymbol : Symbol
+{
+    /// <summary>
+    /// The identifier of this type
+    /// </summary>
+    public abstract IdentifierSymbol Identifier { get; }
+}

tests/Silk.NET.SilkTouch.Symbols.Tests/Silk.NET.SilkTouch.Symbols.Tests.csproj

@@ -14,6 +14,11 @@
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>
+        <PackageReference Include="Moq" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\..\src\generators\Silk.NET.SilkTouch.Symbols\Silk.NET.SilkTouch.Symbols.csproj" />
     </ItemGroup>
 
 </Project>

tests/Silk.NET.SilkTouch.Symbols.Tests/SymbolVisitorTests.cs

@@ -1,10 +1,56 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using Moq;
+using Moq.Protected;
 using Xunit;
 
 namespace Silk.NET.SilkTouch.Symbols.Tests;
 
 public sealed class SymbolVisitorTests
 {
+    [Fact]
+    public void StructSymbolIsVisitedAsType()
+    {
+        var symbol = new StructSymbol(new IdentifierSymbol(""));
+        var visitor = new Mock<SymbolVisitor>
+        {
+            CallBase = true
+        };
+
+        visitor.Object.Visit(symbol);
+        
+        visitor.Protected()
+            .Verify<Symbol>("VisitType", Times.Once(), ItExpr.IsAny<TypeSymbol>());
+    }
+
+    [Fact]
+    public void StructSymbolIsVisitedAsStruct()
+    {
+        var symbol = new StructSymbol(new IdentifierSymbol(""));
+        var visitor = new Mock<SymbolVisitor>
+        {
+            CallBase = true
+        };
+
+        visitor.Object.Visit(symbol);
+        
+        visitor.Protected()
+            .Verify<Symbol>("VisitStruct", Times.Once(), ItExpr.IsAny<StructSymbol>());
+    }
+
+    [Fact]
+    public void StructIdentifierIsVisitedAsIdentifier()
+    {
+        var symbol = new StructSymbol(new IdentifierSymbol(""));
+        var visitor = new Mock<SymbolVisitor>
+        {
+            CallBase = true
+        };
+
+        visitor.Object.Visit(symbol);
+        
+        visitor.Protected()
+            .Verify<Symbol>("VisitIdentifier", Times.Once(), ItExpr.IsAny<IdentifierSymbol>());
+    }
 }