Skip to content

Next Gen STEP AP242 Native-ish BREP Geometric Modeling Kernel

Implement M3a primitive-only lowering plan

Yuechen Lic637c60cbb65
diff --git a/Aetheris.Kernel.Firmament.Tests/FirmamentPrimitiveLoweringTests.cs b/Aetheris.Kernel.Firmament.Tests/FirmamentPrimitiveLoweringTests.cs
new file mode 100644
index 00000000..1492f092
--- /dev/null
+++ b/Aetheris.Kernel.Firmament.Tests/FirmamentPrimitiveLoweringTests.cs
@@ -0,0 +1,150 @@
+using Aetheris.Kernel.Firmament.Lowering;
+
+namespace Aetheris.Kernel.Firmament.Tests;
+
+public sealed class FirmamentPrimitiveLoweringTests
+{
+ [Fact]
+ public void Compile_Lowers_Box_Primitive()
+ {
+ var result = Compile(
+ """
+ firmament:
+ version: 1
+
+ model:
+ name: demo
+ units: mm
+
+ ops[1]:
+ -
+ op: box
+ id: base
+ size[3]:
+ 10
+ 20
+ 30
+ """);
+
+ Assert.True(result.Compilation.IsSuccess);
+ var primitive = Assert.Single(result.Compilation.Value.PrimitiveLoweringPlan!.Primitives);
+ var parameters = Assert.IsType<FirmamentLoweredBoxParameters>(primitive.Parameters);
+ Assert.Equal("base", primitive.FeatureId);
+ Assert.Equal(FirmamentLoweredPrimitiveKind.Box, primitive.Kind);
+ Assert.Equal(10, parameters.SizeX);
+ Assert.Equal(20, parameters.SizeY);
+ Assert.Equal(30, parameters.SizeZ);
+ }
+
+ [Fact]
+ public void Compile_Lowers_Cylinder_Primitive()
+ {
+ var result = Compile(
+ """
+ firmament:
+ version: 1
+
+ model:
+ name: demo
+ units: mm
+
+ ops[1]:
+ -
+ op: cylinder
+ id: hole
+ radius: 3.5
+ height: 8
+ """);
+
+ Assert.True(result.Compilation.IsSuccess);
+ var primitive = Assert.Single(result.Compilation.Value.PrimitiveLoweringPlan!.Primitives);
+ var parameters = Assert.IsType<FirmamentLoweredCylinderParameters>(primitive.Parameters);
+ Assert.Equal("hole", primitive.FeatureId);
+ Assert.Equal(3.5, parameters.Radius);
+ Assert.Equal(8, parameters.Height);
+ }
+
+ [Fact]
+ public void Compile_Lowers_Sphere_Primitive()
+ {
+ var result = Compile(
+ """
+ firmament:
+ version: 1
+
+ model:
+ name: demo
+ units: mm
+
+ ops[1]:
+ -
+ op: sphere
+ id: ball
+ radius: 2
+ """);
+
+ Assert.True(result.Compilation.IsSuccess);
+ var primitive = Assert.Single(result.Compilation.Value.PrimitiveLoweringPlan!.Primitives);
+ var parameters = Assert.IsType<FirmamentLoweredSphereParameters>(primitive.Parameters);
+ Assert.Equal("ball", primitive.FeatureId);
+ Assert.Equal(2, parameters.Radius);
+ }
+
+ [Fact]
+ public void Compile_Lowers_Multiple_Primitives_In_Source_Order()
+ {
+ var result = Compile(FirmamentCorpusHarness.ReadFixtureText("testdata/firmament/fixtures/m3a-valid-multiple-primitives-lower.firmament"));
+
+ Assert.True(result.Compilation.IsSuccess);
+ var plan = result.Compilation.Value.PrimitiveLoweringPlan!;
+ Assert.Collection(
+ plan.Primitives,
+ p => Assert.Equal("b1", p.FeatureId),
+ p => Assert.Equal("c1", p.FeatureId),
+ p => Assert.Equal("s1", p.FeatureId));
+ Assert.Empty(plan.SkippedOps);
+ }
+
+ [Fact]
+ public void Compile_Mixed_Primitive_And_Boolean_Produces_Explicit_SkippedOps()
+ {
+ var result = Compile(FirmamentCorpusHarness.ReadFixtureText("testdata/firmament/fixtures/m3a-mixed-primitive-boolean.firmament"));
+
+ Assert.True(result.Compilation.IsSuccess);
+ var plan = result.Compilation.Value.PrimitiveLoweringPlan!;
+ var primitive = Assert.Single(plan.Primitives);
+ var skipped = Assert.Single(plan.SkippedOps);
+
+ Assert.Equal("base", primitive.FeatureId);
+ Assert.Equal(1, skipped.OpIndex);
+ Assert.Equal("add", skipped.OpName);
+ Assert.Equal("unsupported-op-in-m3a-primitive-only-lowering", skipped.Reason);
+ }
+
+ [Fact]
+ public void Compile_Primitive_Lowering_Output_Is_Deterministic()
+ {
+ var source = FirmamentCorpusHarness.ReadFixtureText("testdata/firmament/fixtures/m3a-valid-primitive-only-lower.firmament");
+
+ var first = Compile(source);
+ var second = Compile(source);
+
+ Assert.True(first.Compilation.IsSuccess);
+ Assert.True(second.Compilation.IsSuccess);
+ Assert.Equivalent(first.Compilation.Value.PrimitiveLoweringPlan, second.Compilation.Value.PrimitiveLoweringPlan);
+ }
+
+ [Fact]
+ public void Compile_ValidationFailure_Prevents_Lowering()
+ {
+ var result = Compile(FirmamentCorpusHarness.ReadFixtureText("testdata/firmament/fixtures/m1a-invalid-sphere-missing-radius.firmament"));
+
+ Assert.False(result.Compilation.IsSuccess);
+ }
+
+ private static FirmamentCompileResult Compile(string source)
+ {
+ var compiler = new FirmamentCompiler();
+ return compiler.Compile(new FirmamentCompileRequest(new FirmamentSourceDocument(source)));
+ }
+}
diff --git a/Aetheris.Kernel.Firmament.Tests/FirmamentScaffoldTests.cs b/Aetheris.Kernel.Firmament.Tests/FirmamentScaffoldTests.cs
index abedd242..572181ac 100644
--- a/Aetheris.Kernel.Firmament.Tests/FirmamentScaffoldTests.cs
+++ b/Aetheris.Kernel.Firmament.Tests/FirmamentScaffoldTests.cs
@@ -37,7 +37,7 @@ public sealed class FirmamentScaffoldTests
Assert.True(result.Compilation.IsSuccess);
var artifact = result.Compilation.Value;
- Assert.Equal("firmament-validation-target-featureid-existence-checked", artifact.ArtifactKind);
+ Assert.Equal("firmament-primitive-lowering-plan-built", artifact.ArtifactKind);
Assert.NotNull(artifact.ParsedDocument);
Assert.Equal("1", artifact.ParsedDocument!.Firmament.Version);
Assert.Equal("demo", artifact.ParsedDocument.Model.Name);
diff --git a/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs b/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs
index 63011ea5..c634862b 100644
--- a/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs
+++ b/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs
@@ -1,7 +1,9 @@
+using Aetheris.Kernel.Firmament.Lowering;
using Aetheris.Kernel.Firmament.ParsedModel;
namespace Aetheris.Kernel.Firmament;
public sealed record FirmamentCompilationArtifact(
- string ArtifactKind = "firmament-validation-target-featureid-existence-checked",
- FirmamentParsedDocument? ParsedDocument = null);
+ string ArtifactKind = "firmament-primitive-lowering-plan-built",
+ FirmamentParsedDocument? ParsedDocument = null,
+ FirmamentPrimitiveLoweringPlan? PrimitiveLoweringPlan = null);
diff --git a/Aetheris.Kernel.Firmament/FirmamentCompiler.cs b/Aetheris.Kernel.Firmament/FirmamentCompiler.cs
index 73acbc63..3412d077 100644
--- a/Aetheris.Kernel.Firmament/FirmamentCompiler.cs
+++ b/Aetheris.Kernel.Firmament/FirmamentCompiler.cs
@@ -1,4 +1,5 @@
using Aetheris.Kernel.Core.Results;
+using Aetheris.Kernel.Firmament.Lowering;
using Aetheris.Kernel.Firmament.Parsing;
using Aetheris.Kernel.Firmament.Validation;
@@ -52,10 +53,18 @@ public sealed class FirmamentCompiler
KernelResult<FirmamentCompilationArtifact>.Failure(documentCoherenceValidationResult.Diagnostics));
}
+ var primitiveLoweringResult = FirmamentPrimitiveLowerer.Lower(targetShapeValidationResult.Value);
+ if (!primitiveLoweringResult.IsSuccess)
+ {
+ return new FirmamentCompileResult(
+ KernelResult<FirmamentCompilationArtifact>.Failure(primitiveLoweringResult.Diagnostics));
+ }
+
return new FirmamentCompileResult(
KernelResult<FirmamentCompilationArtifact>.Success(
new FirmamentCompilationArtifact(
- ArtifactKind: "firmament-validation-target-featureid-existence-checked",
- ParsedDocument: targetShapeValidationResult.Value)));
+ ArtifactKind: "firmament-primitive-lowering-plan-built",
+ ParsedDocument: targetShapeValidationResult.Value,
+ PrimitiveLoweringPlan: primitiveLoweringResult.Value)));
}
}
diff --git a/Aetheris.Kernel.Firmament/Lowering/FirmamentPrimitiveLowerer.cs b/Aetheris.Kernel.Firmament/Lowering/FirmamentPrimitiveLowerer.cs
new file mode 100644
index 00000000..522d2265
--- /dev/null
+++ b/Aetheris.Kernel.Firmament/Lowering/FirmamentPrimitiveLowerer.cs
@@ -0,0 +1,84 @@
+using System.Linq;
+using System.Globalization;
+using System.Text.Json;
+using Aetheris.Kernel.Core.Results;
+using Aetheris.Kernel.Firmament.ParsedModel;
+
+namespace Aetheris.Kernel.Firmament.Lowering;
+
+internal static class FirmamentPrimitiveLowerer
+{
+ private const string PrimitiveOnlySkipReason = "unsupported-op-in-m3a-primitive-only-lowering";
+
+ public static KernelResult<FirmamentPrimitiveLoweringPlan> Lower(FirmamentParsedDocument parsedDocument)
+ {
+ ArgumentNullException.ThrowIfNull(parsedDocument);
+
+ var loweredPrimitives = new List<FirmamentLoweredPrimitive>();
+ var skippedOps = new List<FirmamentLoweringSkippedOp>();
+
+ for (var index = 0; index < parsedDocument.Ops.Entries.Count; index++)
+ {
+ var entry = parsedDocument.Ops.Entries[index];
+ switch (entry.KnownKind)
+ {
+ case FirmamentKnownOpKind.Box:
+ loweredPrimitives.Add(new FirmamentLoweredPrimitive(
+ FeatureId: entry.RawFields["id"],
+ Kind: FirmamentLoweredPrimitiveKind.Box,
+ Parameters: LowerBoxParameters(entry.RawFields["size"])));
+ break;
+
+ case FirmamentKnownOpKind.Cylinder:
+ loweredPrimitives.Add(new FirmamentLoweredPrimitive(
+ FeatureId: entry.RawFields["id"],
+ Kind: FirmamentLoweredPrimitiveKind.Cylinder,
+ Parameters: new FirmamentLoweredCylinderParameters(
+ Radius: ParseScalar(entry.RawFields["radius"]),
+ Height: ParseScalar(entry.RawFields["height"]))));
+ break;
+
+ case FirmamentKnownOpKind.Sphere:
+ loweredPrimitives.Add(new FirmamentLoweredPrimitive(
+ FeatureId: entry.RawFields["id"],
+ Kind: FirmamentLoweredPrimitiveKind.Sphere,
+ Parameters: new FirmamentLoweredSphereParameters(
+ Radius: ParseScalar(entry.RawFields["radius"]))));
+ break;
+
+ default:
+ skippedOps.Add(new FirmamentLoweringSkippedOp(
+ OpIndex: index,
+ OpName: entry.OpName,
+ KnownKind: entry.KnownKind,
+ Family: entry.Family,
+ Reason: PrimitiveOnlySkipReason));
+ break;
+ }
+ }
+
+ return KernelResult<FirmamentPrimitiveLoweringPlan>.Success(new FirmamentPrimitiveLoweringPlan(loweredPrimitives, skippedOps));
+ }
+
+ private static FirmamentLoweredBoxParameters LowerBoxParameters(string sizeRaw)
+ {
+ using var doc = JsonDocument.Parse(sizeRaw);
+ var elements = doc.RootElement.EnumerateArray().ToArray();
+
+ return new FirmamentLoweredBoxParameters(
+ ParseScalar(elements[0].ToString()),
+ ParseScalar(elements[1].ToString()),
+ ParseScalar(elements[2].ToString()));
+ }
+
+ private static double ParseScalar(string raw)
+ {
+ var trimmed = raw.Trim();
+ if (trimmed.StartsWith("\"", StringComparison.Ordinal) && trimmed.EndsWith("\"", StringComparison.Ordinal) && trimmed.Length >= 2)
+ {
+ trimmed = trimmed[1..^1];
+ }
+
+ return double.Parse(trimmed, NumberStyles.Float, CultureInfo.InvariantCulture);
+ }
+}
diff --git a/Aetheris.Kernel.Firmament/Lowering/FirmamentPrimitiveLoweringPlan.cs b/Aetheris.Kernel.Firmament/Lowering/FirmamentPrimitiveLoweringPlan.cs
new file mode 100644
index 00000000..7e5803f9
--- /dev/null
+++ b/Aetheris.Kernel.Firmament/Lowering/FirmamentPrimitiveLoweringPlan.cs
@@ -0,0 +1,37 @@
+using Aetheris.Kernel.Firmament.ParsedModel;
+
+namespace Aetheris.Kernel.Firmament.Lowering;
+
+public sealed record FirmamentPrimitiveLoweringPlan(
+ IReadOnlyList<FirmamentLoweredPrimitive> Primitives,
+ IReadOnlyList<FirmamentLoweringSkippedOp> SkippedOps);
+
+public sealed record FirmamentLoweredPrimitive(
+ string FeatureId,
+ FirmamentLoweredPrimitiveKind Kind,
+ FirmamentLoweredPrimitiveParameters Parameters);
+
+public enum FirmamentLoweredPrimitiveKind
+{
+ Box,
+ Cylinder,
+ Sphere
+}
+
+public abstract record FirmamentLoweredPrimitiveParameters;
+
+public sealed record FirmamentLoweredBoxParameters(double SizeX, double SizeY, double SizeZ)
+ : FirmamentLoweredPrimitiveParameters;
+
+public sealed record FirmamentLoweredCylinderParameters(double Radius, double Height)
+ : FirmamentLoweredPrimitiveParameters;
+
+public sealed record FirmamentLoweredSphereParameters(double Radius)
+ : FirmamentLoweredPrimitiveParameters;
+
+public sealed record FirmamentLoweringSkippedOp(
+ int OpIndex,
+ string OpName,
+ FirmamentKnownOpKind KnownKind,
+ FirmamentOpFamily Family,
+ string Reason);
diff --git a/testdata/firmament/fixtures/m3a-mixed-primitive-boolean.firmament b/testdata/firmament/fixtures/m3a-mixed-primitive-boolean.firmament
new file mode 100644
index 00000000..63d06d14
--- /dev/null
+++ b/testdata/firmament/fixtures/m3a-mixed-primitive-boolean.firmament
@@ -0,0 +1,21 @@
+firmament:
+ version: 1
+
+model:
+ name: demo
+ units: mm
+
+ops[2]:
+ -
+ op: box
+ id: base
+ size[3]:
+ 4
+ 5
+ 6
+ -
+ op: add
+ id: join1
+ to: base
+ with:
+ op: sphere
diff --git a/testdata/firmament/fixtures/m3a-valid-multiple-primitives-lower.firmament b/testdata/firmament/fixtures/m3a-valid-multiple-primitives-lower.firmament
new file mode 100644
index 00000000..c15ac90a
--- /dev/null
+++ b/testdata/firmament/fixtures/m3a-valid-multiple-primitives-lower.firmament
@@ -0,0 +1,24 @@
+firmament:
+ version: 1
+
+model:
+ name: demo
+ units: mm
+
+ops[3]:
+ -
+ op: box
+ id: b1
+ size[3]:
+ 1
+ 2
+ 3
+ -
+ op: cylinder
+ id: c1
+ radius: 4
+ height: 5
+ -
+ op: sphere
+ id: s1
+ radius: 6
diff --git a/testdata/firmament/fixtures/m3a-valid-primitive-only-lower.firmament b/testdata/firmament/fixtures/m3a-valid-primitive-only-lower.firmament
new file mode 100644
index 00000000..91399eaa
--- /dev/null
+++ b/testdata/firmament/fixtures/m3a-valid-primitive-only-lower.firmament
@@ -0,0 +1,15 @@
+firmament:
+ version: 1
+
+model:
+ name: demo
+ units: mm
+
+ops[1]:
+ -
+ op: box
+ id: base
+ size[3]:
+ 10
+ 20
+ 30
diff --git a/testdata/firmament/manifests/m0c.corpus.json b/testdata/firmament/manifests/m0c.corpus.json
index 5336d967..76b52e1b 100644
--- a/testdata/firmament/manifests/m0c.corpus.json
+++ b/testdata/firmament/manifests/m0c.corpus.json
@@ -700,6 +700,24 @@
"kernelCode": "ValidationFailed",
"firmamentCode": "FIRM-REF-0003"
}
+ },
+ {
+ "id": "m3a-valid-primitive-only-lower",
+ "name": "Valid M3a primitive-only lowering plan",
+ "fixturePath": "testdata/firmament/fixtures/m3a-valid-primitive-only-lower.firmament",
+ "expectedOutcome": "success"
+ },
+ {
+ "id": "m3a-valid-multiple-primitives-lower",
+ "name": "Valid M3a multiple primitive lowering plan",
+ "fixturePath": "testdata/firmament/fixtures/m3a-valid-multiple-primitives-lower.firmament",
+ "expectedOutcome": "success"
+ },
+ {
+ "id": "m3a-mixed-primitive-boolean",
+ "name": "Valid M3a mixed primitive and boolean with primitive-only lowering",
+ "fixturePath": "testdata/firmament/fixtures/m3a-mixed-primitive-boolean.firmament",
+ "expectedOutcome": "success"
}
]
}