Skip to content

Next Gen STEP AP242 Native-ish BREP Geometric Modeling Kernel

Implement M5b boolean selector contracts and metadata

Yuechen Li8adab8bb5def
diff --git a/Aetheris.Kernel.Firmament.Tests/FirmamentPrimitiveExecutionTests.cs b/Aetheris.Kernel.Firmament.Tests/FirmamentPrimitiveExecutionTests.cs
index a8469904..b86c6b10 100644
--- a/Aetheris.Kernel.Firmament.Tests/FirmamentPrimitiveExecutionTests.cs
+++ b/Aetheris.Kernel.Firmament.Tests/FirmamentPrimitiveExecutionTests.cs
@@ -118,7 +118,7 @@ public sealed class FirmamentPrimitiveExecutionTests
Assert.True(result.Compilation.IsSuccess);
var artifact = result.Compilation.Value;
- Assert.Equal("firmament-m5a-selector-contract-metadata-validated-primitives-and-booleans-executed", artifact.ArtifactKind);
+ Assert.Equal("firmament-m5b-selector-contract-metadata-validated-primitives-and-booleans-executed", artifact.ArtifactKind);
Assert.Equal(2, artifact.PrimitiveLoweringPlan!.Primitives.Count);
Assert.Equal(2, artifact.PrimitiveLoweringPlan.Booleans.Count);
Assert.Single(artifact.PrimitiveLoweringPlan.SkippedOps);
diff --git a/Aetheris.Kernel.Firmament.Tests/FirmamentScaffoldTests.cs b/Aetheris.Kernel.Firmament.Tests/FirmamentScaffoldTests.cs
index ef0d4a3d..59692767 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-m5a-selector-contract-metadata-validated-primitives-and-booleans-executed", artifact.ArtifactKind);
+ Assert.Equal("firmament-m5b-selector-contract-metadata-validated-primitives-and-booleans-executed", 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.Tests/FirmamentValidationTargetFeatureExistenceTests.cs b/Aetheris.Kernel.Firmament.Tests/FirmamentValidationTargetFeatureExistenceTests.cs
index 1dc4b6e5..0849d77c 100644
--- a/Aetheris.Kernel.Firmament.Tests/FirmamentValidationTargetFeatureExistenceTests.cs
+++ b/Aetheris.Kernel.Firmament.Tests/FirmamentValidationTargetFeatureExistenceTests.cs
@@ -217,4 +217,106 @@ ops[1]:
var validationOp = result.Compilation.Value.ParsedDocument!.Ops.Entries[0];
Assert.Null(validationOp.ClassifiedFields);
}
+
+ [Theory]
+ [InlineData("add", "join", "to", "join.top_face", "Face", "One")]
+ [InlineData("subtract", "cut", "from", "cut.side_faces", "FaceSet", "Many")]
+ [InlineData("intersect", "clip", "left", "clip.edges", "EdgeSet", "Many")]
+ public void Compiler_Attaches_SelectorContractMetadata_For_Legal_BooleanRoot_SelectorTargets(
+ string booleanOp,
+ string featureId,
+ string referenceField,
+ string selectorTarget,
+ string expectedResultKind,
+ string expectedCardinality)
+ {
+ var source = $$"""
+firmament:
+ version: 1
+
+model:
+ name: demo
+ units: mm
+
+ops[3]:
+ -
+ op: box
+ id: base
+ size[3]:
+ 10
+ 20
+ 30
+ -
+ op: {{booleanOp}}
+ id: {{featureId}}
+ {{referenceField}}: base
+ with:
+ op: box
+ size[3]:
+ 1
+ 1
+ 1
+ -
+ op: expect_exists
+ target: {{selectorTarget}}
+""";
+
+ var result = new FirmamentCompiler().Compile(new FirmamentCompileRequest(new FirmamentSourceDocument(source)));
+
+ Assert.True(result.Compilation.IsSuccess);
+ var validationOp = result.Compilation.Value.ParsedDocument!.Ops.Entries[2];
+ Assert.NotNull(validationOp.ClassifiedFields);
+ Assert.Equal("SelectorShaped", validationOp.ClassifiedFields!["targetShape"]);
+ Assert.Equal(expectedResultKind, validationOp.ClassifiedFields["selectorResultKind"]);
+ Assert.Equal(expectedCardinality, validationOp.ClassifiedFields["selectorCardinality"]);
+ }
+
+ [Fact]
+ public void Compiler_Rejects_SelectorShapedValidationTargets_WhenPortNotAllowedByBooleanFeatureContract()
+ {
+ const string source = """
+firmament:
+ version: 1
+
+model:
+ name: demo
+ units: mm
+
+ops[3]:
+ -
+ op: box
+ id: base
+ size[3]:
+ 10
+ 20
+ 30
+ -
+ op: subtract
+ id: cut
+ from: base
+ with:
+ op: box
+ size[3]:
+ 1
+ 1
+ 1
+ -
+ op: expect_exists
+ target: cut.circular_edges
+""";
+
+ var first = new FirmamentCompiler().Compile(new FirmamentCompileRequest(new FirmamentSourceDocument(source)));
+ var second = new FirmamentCompiler().Compile(new FirmamentCompileRequest(new FirmamentSourceDocument(source)));
+
+ Assert.False(first.Compilation.IsSuccess);
+ Assert.False(second.Compilation.IsSuccess);
+
+ var firstDiagnostic = Assert.Single(first.Compilation.Diagnostics);
+ var secondDiagnostic = Assert.Single(second.Compilation.Diagnostics);
+
+ Assert.Equal(firstDiagnostic.Message, secondDiagnostic.Message);
+ Assert.Equal(
+ $"[{FirmamentDiagnosticCodes.ValidationTargetSelectorPortNotAllowedForFeatureKind.Value}] Validation op 'expect_exists' at index 2 has selector port 'circular_edges' not allowed for feature kind 'subtract' on feature id 'cut' via field 'target'.",
+ firstDiagnostic.Message);
+ }
}
diff --git a/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs b/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs
index faf533ef..80d8d3f1 100644
--- a/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs
+++ b/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs
@@ -5,7 +5,7 @@ using Aetheris.Kernel.Firmament.ParsedModel;
namespace Aetheris.Kernel.Firmament;
public sealed record FirmamentCompilationArtifact(
- string ArtifactKind = "firmament-m5a-selector-contract-metadata-validated-primitives-and-booleans-executed",
+ string ArtifactKind = "firmament-m5b-selector-contract-metadata-validated-primitives-and-booleans-executed",
FirmamentParsedDocument? ParsedDocument = null,
FirmamentPrimitiveLoweringPlan? PrimitiveLoweringPlan = null,
FirmamentPrimitiveExecutionResult? PrimitiveExecutionResult = null);
diff --git a/Aetheris.Kernel.Firmament/FirmamentCompiler.cs b/Aetheris.Kernel.Firmament/FirmamentCompiler.cs
index 09b26d43..b47f5099 100644
--- a/Aetheris.Kernel.Firmament/FirmamentCompiler.cs
+++ b/Aetheris.Kernel.Firmament/FirmamentCompiler.cs
@@ -73,7 +73,7 @@ public sealed class FirmamentCompiler
return new FirmamentCompileResult(
KernelResult<FirmamentCompilationArtifact>.Success(
new FirmamentCompilationArtifact(
- ArtifactKind: "firmament-m5a-selector-contract-metadata-validated-primitives-and-booleans-executed",
+ ArtifactKind: "firmament-m5b-selector-contract-metadata-validated-primitives-and-booleans-executed",
ParsedDocument: validatedDocument,
PrimitiveLoweringPlan: primitiveLoweringResult.Value,
PrimitiveExecutionResult: primitiveExecutionResult.Value)));
diff --git a/Aetheris.Kernel.Firmament/Validation/FirmamentDocumentCoherenceValidator.cs b/Aetheris.Kernel.Firmament/Validation/FirmamentDocumentCoherenceValidator.cs
index 59a44a42..07706263 100644
--- a/Aetheris.Kernel.Firmament/Validation/FirmamentDocumentCoherenceValidator.cs
+++ b/Aetheris.Kernel.Firmament/Validation/FirmamentDocumentCoherenceValidator.cs
@@ -129,7 +129,7 @@ internal static class FirmamentDocumentCoherenceValidator
return;
}
- if (!FirmamentPrimitiveSelectorContracts.TryGetAllowedPorts(rootFeatureKind, out var allowedPorts))
+ if (!FirmamentSelectorContracts.TryGetAllowedPorts(rootFeatureKind, out var allowedPorts))
{
return;
}
@@ -142,7 +142,7 @@ internal static class FirmamentDocumentCoherenceValidator
return;
}
- if (!FirmamentPrimitiveSelectorContracts.TryGetPortContract(rootFeatureKind, portToken, out var contract))
+ if (!FirmamentSelectorContracts.TryGetPortContract(rootFeatureKind, portToken, out var contract))
{
return;
}
diff --git a/Aetheris.Kernel.Firmament/Validation/FirmamentPrimitiveSelectorContracts.cs b/Aetheris.Kernel.Firmament/Validation/FirmamentSelectorContracts.cs
similarity index 77%
rename from Aetheris.Kernel.Firmament/Validation/FirmamentPrimitiveSelectorContracts.cs
rename to Aetheris.Kernel.Firmament/Validation/FirmamentSelectorContracts.cs
index 761a3eca..66528d5b 100644
--- a/Aetheris.Kernel.Firmament/Validation/FirmamentPrimitiveSelectorContracts.cs
+++ b/Aetheris.Kernel.Firmament/Validation/FirmamentSelectorContracts.cs
@@ -2,7 +2,7 @@ using Aetheris.Kernel.Firmament.ParsedModel;
namespace Aetheris.Kernel.Firmament.Validation;
-internal static class FirmamentPrimitiveSelectorContracts
+internal static class FirmamentSelectorContracts
{
private static readonly IReadOnlyDictionary<string, FirmamentSelectorPortContract> BoxPorts =
new Dictionary<string, FirmamentSelectorPortContract>(StringComparer.Ordinal)
@@ -33,6 +33,16 @@ internal static class FirmamentPrimitiveSelectorContracts
["vertices"] = new(FirmamentSelectorResultKind.VertexSet, FirmamentSelectorCardinality.Many)
};
+ private static readonly IReadOnlyDictionary<string, FirmamentSelectorPortContract> BooleanPorts =
+ new Dictionary<string, FirmamentSelectorPortContract>(StringComparer.Ordinal)
+ {
+ ["top_face"] = new(FirmamentSelectorResultKind.Face, FirmamentSelectorCardinality.One),
+ ["bottom_face"] = new(FirmamentSelectorResultKind.Face, FirmamentSelectorCardinality.One),
+ ["side_faces"] = new(FirmamentSelectorResultKind.FaceSet, FirmamentSelectorCardinality.Many),
+ ["edges"] = new(FirmamentSelectorResultKind.EdgeSet, FirmamentSelectorCardinality.Many),
+ ["vertices"] = new(FirmamentSelectorResultKind.VertexSet, FirmamentSelectorCardinality.Many)
+ };
+
public static bool TryGetAllowedPorts(FirmamentKnownOpKind featureKind, out IReadOnlySet<string> allowedPorts)
{
switch (featureKind)
@@ -46,6 +56,11 @@ internal static class FirmamentPrimitiveSelectorContracts
case FirmamentKnownOpKind.Sphere:
allowedPorts = SphereAllowedPorts;
return true;
+ case FirmamentKnownOpKind.Add:
+ case FirmamentKnownOpKind.Subtract:
+ case FirmamentKnownOpKind.Intersect:
+ allowedPorts = BooleanAllowedPorts;
+ return true;
default:
allowedPorts = EmptyPorts;
return false;
@@ -77,6 +92,11 @@ internal static class FirmamentPrimitiveSelectorContracts
case FirmamentKnownOpKind.Sphere:
contracts = SpherePorts;
return true;
+ case FirmamentKnownOpKind.Add:
+ case FirmamentKnownOpKind.Subtract:
+ case FirmamentKnownOpKind.Intersect:
+ contracts = BooleanPorts;
+ return true;
default:
contracts = EmptyContracts;
return false;
@@ -89,5 +109,6 @@ internal static class FirmamentPrimitiveSelectorContracts
private static readonly IReadOnlySet<string> BoxAllowedPorts = new HashSet<string>(BoxPorts.Keys, StringComparer.Ordinal);
private static readonly IReadOnlySet<string> CylinderAllowedPorts = new HashSet<string>(CylinderPorts.Keys, StringComparer.Ordinal);
private static readonly IReadOnlySet<string> SphereAllowedPorts = new HashSet<string>(SpherePorts.Keys, StringComparer.Ordinal);
+ private static readonly IReadOnlySet<string> BooleanAllowedPorts = new HashSet<string>(BooleanPorts.Keys, StringComparer.Ordinal);
private static readonly IReadOnlySet<string> EmptyPorts = new HashSet<string>(StringComparer.Ordinal);
}