Merge pull request #68 from hughesjs/generic-constraints

feat: Added support for generic method args

src/SuperFluid.Tests/DemoApiDefinition.fluid.yml

@@ -26,9 +26,16 @@ Methods:
         Type: "int"
       - Name: "direction"
         Type: "string"
+    # These constraints are pointless but are here to test the parser
     GenericArguments:
-      # Pointless generic arg for testing
-      - "T"
+      - Name: "T"
+        Constraints:
+          - "class"
+          - "INumber"
+      - Name: "X"
+        Constraints:
+          - "notnull"
+
     CanTransitionTo:
       - "Stop"
       - "Build"

src/SuperFluid.Tests/SourceGenerators/FluidGeneratorServiceTests.cs

@@ -46,7 +46,7 @@ namespace SuperFluid.Tests.Cars;
 
 										public interface ICanStartOrExit
 										{
-											public ICanStopOrBuild Start<T>(int speed, string direction);
+											public ICanStopOrBuild Start<T,X>(int speed, string direction) where T : class, INumber where X : notnull;
 											public ICanLockOrEnter Exit();
 										}
 										""";

src/SuperFluid/Internal/Definitions/FluidApiMethodDefinition.cs

@@ -11,5 +11,5 @@ internal record FluidApiMethodDefinition
 
 	public List<FluidApiArgumentDefinition> Arguments { get; init; } = new();
 
-	public List<string> GenericArguments { get; init; } = new();
+	public List<FluidGenericArgumentDefinition> GenericArguments { get; init; } = new();
 }

src/SuperFluid/Internal/Definitions/FluidGenericArgumentDefinition.cs

@@ -0,0 +1,10 @@
+namespace SuperFluid.Internal.Definitions;
+
+using System.Diagnostics;
+
+[DebuggerDisplay("{Name}")]
+internal record FluidGenericArgumentDefinition
+{
+    public required List<string> Constraints { get; init; }
+    public required string Name { get; init; }
+}

src/SuperFluid/Internal/Model/FluidApiMethod.cs

@@ -5,7 +5,7 @@ namespace SuperFluid.Internal.Model;
 [DebuggerDisplay("{Name}")]
 internal record FluidApiMethod
 {
-	public FluidApiMethod(string name, string? returnType, IEnumerable<FluidApiMethod> transitions, IEnumerable<FluidApiArgument> args, IEnumerable<string> genericArgs)
+	public FluidApiMethod(string name, string? returnType, IEnumerable<FluidApiMethod> transitions, IEnumerable<FluidApiArgument> args, IEnumerable<FluidGenericArgument> genericArgs)
 	{
 		Name            = name;
 		ReturnType      = returnType;
@@ -21,6 +21,6 @@ public FluidApiMethod(string name, string? returnType, IEnumerable<FluidApiMetho
 
 	internal HashSet<FluidApiArgument> Arguments { get; init; } = new();
 
-	internal HashSet<string> GenericArguments { get; init; } = new();
+	internal HashSet<FluidGenericArgument> GenericArguments { get; init; } = new();
 }
 

src/SuperFluid/Internal/Model/FluidGenericArgument.cs

@@ -0,0 +1,19 @@
+namespace SuperFluid.Internal.Model;
+
+public class FluidGenericArgument
+{
+    public FluidGenericArgument(string name, IEnumerable<string> constraints)
+    {
+        var enumeratedConstraints = constraints as string[] ?? constraints.ToArray();
+        if (enumeratedConstraints.Length == 0)
+        {
+            throw new ArgumentException("Generic argument must have at least one constraint");
+        }
+
+        Name = name;
+        Constraints = [..enumeratedConstraints];
+    }
+
+    internal  HashSet<string> Constraints { get; init; }
+    internal  string Name { get; init; }
+}

src/SuperFluid/Internal/Parsers/FluidApiDefinitionParser.cs

@@ -87,7 +87,9 @@ private FluidApiMethod FindOrCreateMethod(FluidApiDefinition definition, FluidAp
 
 		List<FluidApiArgument> args = method.Arguments.Select(a => new FluidApiArgument(a.Name, a.Type)).ToList();
 
-		FluidApiMethod newMethod = new(method.Name, method.ReturnType, Array.Empty<FluidApiMethod>(), args, method.GenericArguments);
+		List<FluidGenericArgument> genericArgs = method.GenericArguments.Select(a => new FluidGenericArgument(a.Name, a.Constraints)).ToList();
+
+		FluidApiMethod newMethod = new(method.Name, method.ReturnType, Array.Empty<FluidApiMethod>(), args, genericArgs);
 		stateDict.Add(method, newMethod);
 
 		List<FluidApiMethodDefinition> transitionDefinitions = method.CanTransitionTo.Select(m => definition.Methods.Single(d => d.Name == m)).ToList();

src/SuperFluid/Internal/Services/FluidGeneratorService.cs

@@ -42,14 +42,18 @@ public interface {{model.Name}}: {{string.Join(",", model.States.Select(s => s.N
 		return source;
 	}
 
-	private string GenerateStateSource(FluidApiState fluidApiState, FluidApiModel model)
+	private string GenerateStateSource(FluidApiState fluidApiState, FluidApiModel model) 
 	{
 		IEnumerable<string> methodDeclarations = fluidApiState.MethodTransitions.Select(kvp
 																							=>
 		{
-			string genericArgs = kvp.Key.GenericArguments.Count > 0 ? $"<{string.Join(", ", kvp.Key.GenericArguments.Select(a => $"{a}"))}>" : string.Empty;
+			string genericArgs = kvp.Key.GenericArguments.Count > 0 ? $"<{string.Join(",", kvp.Key.GenericArguments.Select(a => $"{a.Name}"))}>" : string.Empty;
+
+			string constraints = kvp.Key.GenericArguments.Count > 0 ? $" {string.Join(" ", kvp.Key.GenericArguments.Select(a => $"where {a.Name} : {string.Join(", ", a.Constraints)}"))}" : string.Empty;
+
+
 			return $"""
-			        	public {kvp.Key.ReturnType ?? kvp.Value.Name} {kvp.Key.Name}{genericArgs}({string.Join(", ", kvp.Key.Arguments.Select(a => $"{a.Type} {a.Name}"))});
+			        	public {kvp.Key.ReturnType ?? kvp.Value.Name} {kvp.Key.Name}{genericArgs}({string.Join(", ", kvp.Key.Arguments.Select(a => $"{a.Type} {a.Name}"))}){constraints};
 			        """;
 		});