Skip to content

Next Gen STEP AP242 Native-ish BREP Geometric Modeling Kernel

Firmament M0d: classify known ops by family

Yuechen Lib85cd0f05b35
diff --git a/Aetheris.Kernel.Firmament.Tests/FirmamentScaffoldTests.cs b/Aetheris.Kernel.Firmament.Tests/FirmamentScaffoldTests.cs
index d0c99156..e4882238 100644
--- a/Aetheris.Kernel.Firmament.Tests/FirmamentScaffoldTests.cs
+++ b/Aetheris.Kernel.Firmament.Tests/FirmamentScaffoldTests.cs
@@ -34,7 +34,7 @@ public sealed class FirmamentScaffoldTests
Assert.True(result.Compilation.IsSuccess);
var artifact = result.Compilation.Value;
- Assert.Equal("firmament-ops-structure-known-kind-parsed", artifact.ArtifactKind);
+ Assert.Equal("firmament-ops-structure-known-kind-family-parsed", artifact.ArtifactKind);
Assert.NotNull(artifact.ParsedDocument);
Assert.Equal("1", artifact.ParsedDocument!.Firmament.Version);
Assert.Equal("demo", artifact.ParsedDocument.Model.Name);
@@ -92,9 +92,50 @@ public sealed class FirmamentScaffoldTests
var op = Assert.Single(result.Compilation.Value.ParsedDocument!.Ops.Entries);
Assert.Equal("sphere", op.OpName);
Assert.Equal(FirmamentKnownOpKind.Sphere, op.KnownKind);
+ Assert.Equal(FirmamentOpFamily.Primitive, op.Family);
Assert.Equal("x", op.RawFields["note"]);
}
+
+ [Fact]
+ public void Compiler_Classifies_KnownPrimitiveOpFamily() =>
+ AssertClassifiedFamily("box", FirmamentOpFamily.Primitive);
+
+ [Fact]
+ public void Compiler_Classifies_KnownBooleanOpFamily() =>
+ AssertClassifiedFamily("intersect", FirmamentOpFamily.Boolean);
+
+ [Fact]
+ public void Compiler_Classifies_KnownValidationOpFamily() =>
+ AssertClassifiedFamily("expect_selectable", FirmamentOpFamily.Validation);
+
+ [Fact]
+ public void Compiler_Preserves_FamilyClassification_ForMultipleOps()
+ {
+ var compiler = new FirmamentCompiler();
+ var source = """
+ {
+ "firmament": { "version": "1" },
+ "model": { "name": "demo", "units": "mm" },
+ "ops": [
+ { "op": "box" },
+ { "op": "subtract" },
+ { "op": "expect_manifold" }
+ ]
+ }
+ """;
+
+ var result = compiler.Compile(new FirmamentCompileRequest(new FirmamentSourceDocument(source)));
+
+ Assert.True(result.Compilation.IsSuccess);
+ var ops = result.Compilation.Value.ParsedDocument!.Ops.Entries;
+ Assert.Collection(
+ ops,
+ op => Assert.Equal(FirmamentOpFamily.Primitive, op.Family),
+ op => Assert.Equal(FirmamentOpFamily.Boolean, op.Family),
+ op => Assert.Equal(FirmamentOpFamily.Validation, op.Family));
+ }
+
[Fact]
public void Compiler_Accepts_KnownBooleanOp() =>
AssertValidOpsCount(
@@ -388,6 +429,26 @@ public sealed class FirmamentScaffoldTests
Assert.Equal(expectedOps, result.Compilation.Value.ParsedDocument!.Ops.Entries.Count);
}
+ private static void AssertClassifiedFamily(string opName, FirmamentOpFamily expectedFamily)
+ {
+ var compiler = new FirmamentCompiler();
+ var source = $$"""
+ {
+ "firmament": { "version": "1" },
+ "model": { "name": "demo", "units": "mm" },
+ "ops": [
+ { "op": "{{opName}}" }
+ ]
+ }
+ """;
+
+ var result = compiler.Compile(new FirmamentCompileRequest(new FirmamentSourceDocument(source)));
+
+ Assert.True(result.Compilation.IsSuccess);
+ var op = Assert.Single(result.Compilation.Value.ParsedDocument!.Ops.Entries);
+ Assert.Equal(expectedFamily, op.Family);
+ }
+
private static void AssertSingleValidationError(string source, FirmamentDiagnosticCode expectedFirmamentCode, string expectedMessageTail)
{
var compiler = new FirmamentCompiler();
diff --git a/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs b/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs
index 144334de..ad2fc951 100644
--- a/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs
+++ b/Aetheris.Kernel.Firmament/FirmamentCompilationArtifact.cs
@@ -3,5 +3,5 @@ using Aetheris.Kernel.Firmament.ParsedModel;
namespace Aetheris.Kernel.Firmament;
public sealed record FirmamentCompilationArtifact(
- string ArtifactKind = "firmament-ops-structure-known-kind-parsed",
+ string ArtifactKind = "firmament-ops-structure-known-kind-family-parsed",
FirmamentParsedDocument? ParsedDocument = null);
diff --git a/Aetheris.Kernel.Firmament/ParsedModel/FirmamentKnownOpKind.cs b/Aetheris.Kernel.Firmament/ParsedModel/FirmamentKnownOpKind.cs
index 1b7f5633..31f09e09 100644
--- a/Aetheris.Kernel.Firmament/ParsedModel/FirmamentKnownOpKind.cs
+++ b/Aetheris.Kernel.Firmament/ParsedModel/FirmamentKnownOpKind.cs
@@ -31,4 +31,19 @@ internal static class FirmamentKnownOpKinds
public static bool TryParse(string opName, out FirmamentKnownOpKind kind) =>
Registry.TryGetValue(opName, out kind);
+
+ public static FirmamentOpFamily ClassifyFamily(FirmamentKnownOpKind kind) =>
+ kind switch
+ {
+ FirmamentKnownOpKind.Box => FirmamentOpFamily.Primitive,
+ FirmamentKnownOpKind.Cylinder => FirmamentOpFamily.Primitive,
+ FirmamentKnownOpKind.Sphere => FirmamentOpFamily.Primitive,
+ FirmamentKnownOpKind.Add => FirmamentOpFamily.Boolean,
+ FirmamentKnownOpKind.Subtract => FirmamentOpFamily.Boolean,
+ FirmamentKnownOpKind.Intersect => FirmamentOpFamily.Boolean,
+ FirmamentKnownOpKind.ExpectExists => FirmamentOpFamily.Validation,
+ FirmamentKnownOpKind.ExpectSelectable => FirmamentOpFamily.Validation,
+ FirmamentKnownOpKind.ExpectManifold => FirmamentOpFamily.Validation,
+ _ => throw new ArgumentOutOfRangeException(nameof(kind), kind, "Unknown Firmament known op kind.")
+ };
}
diff --git a/Aetheris.Kernel.Firmament/ParsedModel/FirmamentOpFamily.cs b/Aetheris.Kernel.Firmament/ParsedModel/FirmamentOpFamily.cs
new file mode 100644
index 00000000..37a77f11
--- /dev/null
+++ b/Aetheris.Kernel.Firmament/ParsedModel/FirmamentOpFamily.cs
@@ -0,0 +1,8 @@
+namespace Aetheris.Kernel.Firmament.ParsedModel;
+
+public enum FirmamentOpFamily
+{
+ Primitive,
+ Boolean,
+ Validation
+}
diff --git a/Aetheris.Kernel.Firmament/ParsedModel/FirmamentParsedDocument.cs b/Aetheris.Kernel.Firmament/ParsedModel/FirmamentParsedDocument.cs
index ceffb79d..87055c48 100644
--- a/Aetheris.Kernel.Firmament/ParsedModel/FirmamentParsedDocument.cs
+++ b/Aetheris.Kernel.Firmament/ParsedModel/FirmamentParsedDocument.cs
@@ -16,4 +16,5 @@ public sealed record FirmamentParsedOpsSection(IReadOnlyList<FirmamentParsedOpEn
public sealed record FirmamentParsedOpEntry(
string OpName,
FirmamentKnownOpKind KnownKind,
+ FirmamentOpFamily Family,
IReadOnlyDictionary<string, string> RawFields);
diff --git a/Aetheris.Kernel.Firmament/Parsing/FirmamentTopLevelParser.cs b/Aetheris.Kernel.Firmament/Parsing/FirmamentTopLevelParser.cs
index 26d2145b..dda38220 100644
--- a/Aetheris.Kernel.Firmament/Parsing/FirmamentTopLevelParser.cs
+++ b/Aetheris.Kernel.Firmament/Parsing/FirmamentTopLevelParser.cs
@@ -244,7 +244,8 @@ internal static class FirmamentTopLevelParser
return UnknownOpKind(index, opName);
}
- entries.Add(new FirmamentParsedOpEntry(opName, knownKind, rawFields));
+ var family = FirmamentKnownOpKinds.ClassifyFamily(knownKind);
+ entries.Add(new FirmamentParsedOpEntry(opName, knownKind, family, rawFields));
index++;
}
@@ -277,7 +278,8 @@ internal static class FirmamentTopLevelParser
return UnknownOpKind(index, opName);
}
- entries.Add(new FirmamentParsedOpEntry(opName, knownKind, new Dictionary<string, string>(opEntry.Fields, StringComparer.Ordinal)));
+ var family = FirmamentKnownOpKinds.ClassifyFamily(knownKind);
+ entries.Add(new FirmamentParsedOpEntry(opName, knownKind, family, new Dictionary<string, string>(opEntry.Fields, StringComparer.Ordinal)));
}
return KernelResult<IReadOnlyList<FirmamentParsedOpEntry>>.Success(entries);