Skip to content

Next Gen STEP AP242 Native-ish BREP Geometric Modeling Kernel

Firmament M5a: attach selector result kind and cardinality metadata

Yuechen Li7d51aec5985c
diff --git a/Aetheris.Kernel.Firmament.Tests/FirmamentPrimitiveExecutionTests.cs b/Aetheris.Kernel.Firmament.Tests/FirmamentPrimitiveExecutionTests.cs
index 5c624e63..a8469904 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-m4b-selector-port-surface-validated-primitives-and-booleans-executed", artifact.ArtifactKind);
+ Assert.Equal("firmament-m5a-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 9d3f80ad..ef0d4a3d 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-m4b-selector-port-surface-validated-primitives-and-booleans-executed", artifact.ArtifactKind);
+ Assert.Equal("firmament-m5a-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 1486f469..1dc4b6e5 100644
--- a/Aetheris.Kernel.Firmament.Tests/FirmamentValidationTargetFeatureExistenceTests.cs
+++ b/Aetheris.Kernel.Firmament.Tests/FirmamentValidationTargetFeatureExistenceTests.cs
@@ -2,7 +2,7 @@ using Aetheris.Kernel.Firmament.Diagnostics;
namespace Aetheris.Kernel.Firmament.Tests;
-public sealed class FirmamentValidationTargetFeatureExistenceTests
+public sealed partial class FirmamentValidationTargetFeatureExistenceTests
{
[Theory]
[InlineData("testdata/firmament/fixtures/m2c-valid-expect-exists-bare-target-earlier.firmament")]
@@ -130,3 +130,91 @@ public sealed class FirmamentValidationTargetFeatureExistenceTests
return compiler.Compile(new FirmamentCompileRequest(new FirmamentSourceDocument(fixtureText)));
}
}
+
+public sealed partial class FirmamentValidationTargetFeatureExistenceTests
+{
+ [Theory]
+ [InlineData("base.top_face", "Face", "One")]
+ [InlineData("base.side_faces", "FaceSet", "Many")]
+ [InlineData("cyl.side_face", "Face", "One")]
+ [InlineData("cyl.circular_edges", "EdgeSet", "Many")]
+ [InlineData("sphere.surface", "Face", "One")]
+ [InlineData("sphere.vertices", "VertexSet", "Many")]
+ public void Compiler_Attaches_SelectorContractMetadata_For_Legal_SelectorTargets(string selectorTarget, string expectedResultKind, string expectedCardinality)
+ {
+ var source = $$"""
+firmament:
+ version: 1
+
+model:
+ name: demo
+ units: mm
+
+ops[4]:
+ -
+ op: box
+ id: base
+ size[3]:
+ 10
+ 20
+ 30
+ -
+ op: cylinder
+ id: cyl
+ radius: 2
+ height: 5
+ -
+ op: sphere
+ id: sphere
+ radius: 4
+ -
+ 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[3];
+ 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_DoesNotAttach_SelectorMetadata_For_BareFeatureIdTarget()
+ {
+ var result = CompileFixture("testdata/firmament/fixtures/m2c-valid-expect-exists-bare-target-earlier.firmament");
+
+ Assert.True(result.Compilation.IsSuccess);
+ var validationOp = result.Compilation.Value.ParsedDocument!.Ops.Entries[1];
+ Assert.NotNull(validationOp.ClassifiedFields);
+ Assert.Equal("FeatureId", validationOp.ClassifiedFields!["targetShape"]);
+ Assert.False(validationOp.ClassifiedFields.ContainsKey("selectorResultKind"));
+ Assert.False(validationOp.ClassifiedFields.ContainsKey("selectorCardinality"));
+ }
+
+ [Fact]
+ public void Compiler_DoesNotAttach_SelectorMetadata_For_NonSelectorValidationOps()
+ {
+ var source = """
+firmament:
+ version: 1
+
+model:
+ name: demo
+ units: mm
+
+ops[1]:
+ -
+ op: expect_manifold
+""";
+
+ var result = new FirmamentCompiler().Compile(new FirmamentCompileRequest(new FirmamentSourceDocument(source)));
+
+ Assert.True(result.Compilation.IsSuccess);
+ var validationOp = result.Compilation.Value.ParsedDocument!.Ops.Entries[0];
+ Assert.Null(validationOp.ClassifiedFields);
+ }
+}
diff --git a/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs b/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs
index 7f9b9e6b..faf533ef 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-m4b-selector-port-surface-validated-primitives-and-booleans-executed",
+ string ArtifactKind = "firmament-m5a-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 ae800147..09b26d43 100644
--- a/Aetheris.Kernel.Firmament/FirmamentCompiler.cs
+++ b/Aetheris.Kernel.Firmament/FirmamentCompiler.cs
@@ -54,7 +54,9 @@ public sealed class FirmamentCompiler
KernelResult<FirmamentCompilationArtifact>.Failure(documentCoherenceValidationResult.Diagnostics));
}
- var primitiveLoweringResult = FirmamentPrimitiveLowerer.Lower(targetShapeValidationResult.Value);
+ var validatedDocument = documentCoherenceValidationResult.Value;
+
+ var primitiveLoweringResult = FirmamentPrimitiveLowerer.Lower(validatedDocument);
if (!primitiveLoweringResult.IsSuccess)
{
return new FirmamentCompileResult(
@@ -71,8 +73,8 @@ public sealed class FirmamentCompiler
return new FirmamentCompileResult(
KernelResult<FirmamentCompilationArtifact>.Success(
new FirmamentCompilationArtifact(
- ArtifactKind: "firmament-m4b-selector-port-surface-validated-primitives-and-booleans-executed",
- ParsedDocument: targetShapeValidationResult.Value,
+ ArtifactKind: "firmament-m5a-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 c95fdee4..59a44a42 100644
--- a/Aetheris.Kernel.Firmament/Validation/FirmamentDocumentCoherenceValidator.cs
+++ b/Aetheris.Kernel.Firmament/Validation/FirmamentDocumentCoherenceValidator.cs
@@ -7,12 +7,13 @@ namespace Aetheris.Kernel.Firmament.Validation;
internal static class FirmamentDocumentCoherenceValidator
{
- public static KernelResult<bool> Validate(FirmamentParsedDocument parsedDocument)
+ public static KernelResult<FirmamentParsedDocument> Validate(FirmamentParsedDocument parsedDocument)
{
ArgumentNullException.ThrowIfNull(parsedDocument);
var featureIds = new HashSet<string>(StringComparer.Ordinal);
var featureKindsById = new Dictionary<string, FirmamentKnownOpKind>(StringComparer.Ordinal);
+ var updatedEntries = new List<FirmamentParsedOpEntry>(parsedDocument.Ops.Entries.Count);
for (var index = 0; index < parsedDocument.Ops.Entries.Count; index++)
{
@@ -20,15 +21,18 @@ internal static class FirmamentDocumentCoherenceValidator
if (entry.Family == FirmamentOpFamily.Validation)
{
- ValidateValidationTargetReference(entry, index, featureIds, featureKindsById, out var diagnostic);
+ ValidateValidationTargetReference(entry, index, featureIds, featureKindsById, out var diagnostic, out var enrichedEntry);
if (diagnostic is not null)
{
- return KernelResult<bool>.Failure([diagnostic]);
+ return KernelResult<FirmamentParsedDocument>.Failure([diagnostic]);
}
+ updatedEntries.Add(enrichedEntry ?? entry);
continue;
}
+ updatedEntries.Add(entry);
+
var featureId = entry.RawFields["id"];
if (entry.Family == FirmamentOpFamily.Boolean)
{
@@ -36,7 +40,7 @@ internal static class FirmamentDocumentCoherenceValidator
var referenceId = entry.RawFields[referenceFieldName];
if (!featureIds.Contains(referenceId))
{
- return KernelResult<bool>.Failure([
+ return KernelResult<FirmamentParsedDocument>.Failure([
CreateDiagnostic(
FirmamentDiagnosticCodes.ReferenceUnknownFeatureId,
$"Boolean op '{entry.OpName}' at index {index} references unknown feature id '{referenceId}' via field '{referenceFieldName}'.")
@@ -46,7 +50,7 @@ internal static class FirmamentDocumentCoherenceValidator
if (!featureIds.Add(featureId))
{
- return KernelResult<bool>.Failure([
+ return KernelResult<FirmamentParsedDocument>.Failure([
CreateDiagnostic(
FirmamentDiagnosticCodes.ReferenceDuplicateFeatureId,
$"Feature-producing op '{entry.OpName}' at index {index} reuses duplicate feature id '{featureId}'.")
@@ -56,7 +60,12 @@ internal static class FirmamentDocumentCoherenceValidator
featureKindsById[featureId] = entry.KnownKind;
}
- return KernelResult<bool>.Success(true);
+ var updatedDocument = parsedDocument with
+ {
+ Ops = parsedDocument.Ops with { Entries = updatedEntries }
+ };
+
+ return KernelResult<FirmamentParsedDocument>.Success(updatedDocument);
}
private static void ValidateValidationTargetReference(
@@ -64,9 +73,11 @@ internal static class FirmamentDocumentCoherenceValidator
int index,
HashSet<string> featureIds,
IReadOnlyDictionary<string, FirmamentKnownOpKind> featureKindsById,
- out KernelDiagnostic? diagnostic)
+ out KernelDiagnostic? diagnostic,
+ out FirmamentParsedOpEntry? enrichedEntry)
{
diagnostic = null;
+ enrichedEntry = null;
if (entry.KnownKind is not (FirmamentKnownOpKind.ExpectExists or FirmamentKnownOpKind.ExpectSelectable)
|| !entry.RawFields.TryGetValue("target", out var targetRaw))
@@ -128,7 +139,22 @@ internal static class FirmamentDocumentCoherenceValidator
diagnostic = CreateDiagnostic(
FirmamentDiagnosticCodes.ValidationTargetSelectorPortNotAllowedForFeatureKind,
$"Validation op '{entry.OpName}' at index {index} has selector port '{portToken}' not allowed for feature kind '{rootFeatureKind.ToString().ToLowerInvariant()}' on feature id '{rootFeatureId}' via field 'target'.");
+ return;
+ }
+
+ if (!FirmamentPrimitiveSelectorContracts.TryGetPortContract(rootFeatureKind, portToken, out var contract))
+ {
+ return;
}
+
+ var classifiedFields = entry.ClassifiedFields is null
+ ? new Dictionary<string, string>(StringComparer.Ordinal)
+ : new Dictionary<string, string>(entry.ClassifiedFields, StringComparer.Ordinal);
+
+ classifiedFields["selectorResultKind"] = contract.ResultKind.ToString();
+ classifiedFields["selectorCardinality"] = contract.Cardinality.ToString();
+
+ enrichedEntry = entry with { ClassifiedFields = classifiedFields };
}
private static string ExtractSelectorRoot(string target)
diff --git a/Aetheris.Kernel.Firmament/Validation/FirmamentPrimitiveSelectorContracts.cs b/Aetheris.Kernel.Firmament/Validation/FirmamentPrimitiveSelectorContracts.cs
index de77e248..761a3eca 100644
--- a/Aetheris.Kernel.Firmament/Validation/FirmamentPrimitiveSelectorContracts.cs
+++ b/Aetheris.Kernel.Firmament/Validation/FirmamentPrimitiveSelectorContracts.cs
@@ -4,44 +4,47 @@ namespace Aetheris.Kernel.Firmament.Validation;
internal static class FirmamentPrimitiveSelectorContracts
{
- private static readonly IReadOnlySet<string> BoxPorts = new HashSet<string>(StringComparer.Ordinal)
- {
- "top_face",
- "bottom_face",
- "side_faces",
- "edges",
- "vertices"
- };
-
- private static readonly IReadOnlySet<string> CylinderPorts = new HashSet<string>(StringComparer.Ordinal)
- {
- "top_face",
- "bottom_face",
- "side_face",
- "circular_edges",
- "edges",
- "vertices"
- };
-
- private static readonly IReadOnlySet<string> SpherePorts = new HashSet<string>(StringComparer.Ordinal)
- {
- "surface",
- "edges",
- "vertices"
- };
+ private static readonly IReadOnlyDictionary<string, FirmamentSelectorPortContract> BoxPorts =
+ 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)
+ };
+
+ private static readonly IReadOnlyDictionary<string, FirmamentSelectorPortContract> CylinderPorts =
+ new Dictionary<string, FirmamentSelectorPortContract>(StringComparer.Ordinal)
+ {
+ ["top_face"] = new(FirmamentSelectorResultKind.Face, FirmamentSelectorCardinality.One),
+ ["bottom_face"] = new(FirmamentSelectorResultKind.Face, FirmamentSelectorCardinality.One),
+ ["side_face"] = new(FirmamentSelectorResultKind.Face, FirmamentSelectorCardinality.One),
+ ["circular_edges"] = new(FirmamentSelectorResultKind.EdgeSet, FirmamentSelectorCardinality.Many),
+ ["edges"] = new(FirmamentSelectorResultKind.EdgeSet, FirmamentSelectorCardinality.Many),
+ ["vertices"] = new(FirmamentSelectorResultKind.VertexSet, FirmamentSelectorCardinality.Many)
+ };
+
+ private static readonly IReadOnlyDictionary<string, FirmamentSelectorPortContract> SpherePorts =
+ new Dictionary<string, FirmamentSelectorPortContract>(StringComparer.Ordinal)
+ {
+ ["surface"] = new(FirmamentSelectorResultKind.Face, FirmamentSelectorCardinality.One),
+ ["edges"] = new(FirmamentSelectorResultKind.EdgeSet, FirmamentSelectorCardinality.Many),
+ ["vertices"] = new(FirmamentSelectorResultKind.VertexSet, FirmamentSelectorCardinality.Many)
+ };
public static bool TryGetAllowedPorts(FirmamentKnownOpKind featureKind, out IReadOnlySet<string> allowedPorts)
{
switch (featureKind)
{
case FirmamentKnownOpKind.Box:
- allowedPorts = BoxPorts;
+ allowedPorts = BoxAllowedPorts;
return true;
case FirmamentKnownOpKind.Cylinder:
- allowedPorts = CylinderPorts;
+ allowedPorts = CylinderAllowedPorts;
return true;
case FirmamentKnownOpKind.Sphere:
- allowedPorts = SpherePorts;
+ allowedPorts = SphereAllowedPorts;
return true;
default:
allowedPorts = EmptyPorts;
@@ -49,5 +52,42 @@ internal static class FirmamentPrimitiveSelectorContracts
}
}
+ public static bool TryGetPortContract(FirmamentKnownOpKind featureKind, string portToken, out FirmamentSelectorPortContract contract)
+ {
+ if (TryGetContracts(featureKind, out var contracts) && contracts.TryGetValue(portToken, out var value))
+ {
+ contract = value;
+ return true;
+ }
+
+ contract = null!;
+ return false;
+ }
+
+ private static bool TryGetContracts(FirmamentKnownOpKind featureKind, out IReadOnlyDictionary<string, FirmamentSelectorPortContract> contracts)
+ {
+ switch (featureKind)
+ {
+ case FirmamentKnownOpKind.Box:
+ contracts = BoxPorts;
+ return true;
+ case FirmamentKnownOpKind.Cylinder:
+ contracts = CylinderPorts;
+ return true;
+ case FirmamentKnownOpKind.Sphere:
+ contracts = SpherePorts;
+ return true;
+ default:
+ contracts = EmptyContracts;
+ return false;
+ }
+ }
+
+ private static readonly IReadOnlyDictionary<string, FirmamentSelectorPortContract> EmptyContracts =
+ new Dictionary<string, FirmamentSelectorPortContract>(StringComparer.Ordinal);
+
+ 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> EmptyPorts = new HashSet<string>(StringComparer.Ordinal);
}
diff --git a/Aetheris.Kernel.Firmament/Validation/FirmamentSelectorPortContractMetadata.cs b/Aetheris.Kernel.Firmament/Validation/FirmamentSelectorPortContractMetadata.cs
new file mode 100644
index 00000000..bbb381bd
--- /dev/null
+++ b/Aetheris.Kernel.Firmament/Validation/FirmamentSelectorPortContractMetadata.cs
@@ -0,0 +1,20 @@
+namespace Aetheris.Kernel.Firmament.Validation;
+
+internal enum FirmamentSelectorResultKind
+{
+ Face,
+ FaceSet,
+ EdgeSet,
+ VertexSet
+}
+
+internal enum FirmamentSelectorCardinality
+{
+ One,
+ Many
+}
+
+internal sealed record FirmamentSelectorPortContract(
+ FirmamentSelectorResultKind ResultKind,
+ FirmamentSelectorCardinality Cardinality);
+