Add default implementation for importGeometry()

nicklockwood · nicklockwood · commit 1a487028c665 · 2023-12-31T20:09:14.000Z
diff --git a/ShapeScript.xcodeproj/project.pbxproj b/ShapeScript.xcodeproj/project.pbxproj
@@ -85,6 +85,7 @@
 		0183AAED28EC3ACB00AD1984 /* Settings+Editor.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0183AAE128EC3ACB00AD1984 /* Settings+Editor.swift */; };
 		01977FCB215D0BD400D65D5E /* Scene.swift in Sources */ = {isa = PBXBuildFile; fileRef = 01977FCA215D0BD400D65D5E /* Scene.swift */; };
 		019853A228360F7500047DF2 /* TypesystemTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 019853A128360F7500047DF2 /* TypesystemTests.swift */; };
+		01994BF82B3EB7EE004DE69C /* EvaluationDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 01994BF72B3EB7EE004DE69C /* EvaluationDelegate.swift */; };
 		01A6FE7D2AEF5BCB006AE113 /* Members.swift in Sources */ = {isa = PBXBuildFile; fileRef = 01A6FE7C2AEF5BCB006AE113 /* Members.swift */; };
 		01A6FE832AEF5D2A006AE113 /* MemberTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 01A6FE822AEF5D2A006AE113 /* MemberTests.swift */; };
 		01A6FECD2AF9ADB1006AE113 /* Material+SceneKit.swift in Sources */ = {isa = PBXBuildFile; fileRef = 01A6FECC2AF9ADB1006AE113 /* Material+SceneKit.swift */; };
@@ -391,6 +392,7 @@
 		0183AAE128EC3ACB00AD1984 /* Settings+Editor.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Settings+Editor.swift"; sourceTree = "<group>"; };
 		01977FCA215D0BD400D65D5E /* Scene.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Scene.swift; sourceTree = "<group>"; };
 		019853A128360F7500047DF2 /* TypesystemTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TypesystemTests.swift; sourceTree = "<group>"; };
+		01994BF72B3EB7EE004DE69C /* EvaluationDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EvaluationDelegate.swift; sourceTree = "<group>"; };
 		01A6FE7C2AEF5BCB006AE113 /* Members.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Members.swift; sourceTree = "<group>"; };
 		01A6FE822AEF5D2A006AE113 /* MemberTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MemberTests.swift; sourceTree = "<group>"; };
 		01A6FECC2AF9ADB1006AE113 /* Material+SceneKit.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Material+SceneKit.swift"; sourceTree = "<group>"; };
@@ -640,6 +642,7 @@
 				014F85D8215B890100461FB7 /* Interpreter.swift */,
 				01DE96702A082A6A0080DB79 /* ProgramError.swift */,
 				013312D221C9BBCC00626F1B /* EvaluationContext.swift */,
+				01994BF72B3EB7EE004DE69C /* EvaluationDelegate.swift */,
 				013DB0BD21C8731C00DFB0D2 /* StandardLibrary.swift */,
 				01BD943821936B90005FFAEC /* RandomSequence.swift */,
 				01FDE3D426BD766C00A46F66 /* GeometryCache.swift */,
@@ -1140,6 +1143,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				01994BF82B3EB7EE004DE69C /* EvaluationDelegate.swift in Sources */,
 				01CF787226EA36AD0097907A /* String+Ordinals.swift in Sources */,
 				014F85D9215B890100461FB7 /* Interpreter.swift in Sources */,
 				01E3AA0526CB8E8200E0B287 /* Value+Logging.swift in Sources */,
diff --git a/ShapeScript/EvaluationContext.swift b/ShapeScript/EvaluationContext.swift
@@ -17,6 +17,10 @@ import CoreGraphics
 import CoreText
 #endif
 
+#if canImport(SceneKit)
+import SceneKit
+#endif
+
 // MARK: Implementation
 
 public struct SourceLocation: Hashable {
@@ -328,6 +332,52 @@ extension EvaluationContext {
         #endif
     }
 
+    func importGeometry(at url: URL) throws -> Geometry? {
+        if let geometry = try delegate?.importGeometry(for: url) {
+            // Allow delegate to implement alternative loading mechanism, e.g. hard-coded geometry for testing
+            return geometry
+        }
+        switch url.pathExtension.lowercased() {
+        case "stl", "stla":
+            let data = try Data(contentsOf: url)
+            if let mesh = Mesh(stlData: data, materialLookup: {
+                Material(color: $0)
+            }) {
+                return Geometry(
+                    type: .mesh(mesh),
+                    name: nil,
+                    transform: .identity,
+                    material: .default,
+                    smoothing: nil,
+                    children: [],
+                    sourceLocation: nil
+                )
+            }
+        default:
+            break
+        }
+        var isDirectory: ObjCBool = false
+        _ = FileManager.default.fileExists(atPath: url.path, isDirectory: &isDirectory)
+        var url = url
+        if isDirectory.boolValue {
+            let newURL = url.appendingPathComponent(url.lastPathComponent)
+            if FileManager.default.fileExists(atPath: newURL.path) {
+                url = newURL
+            }
+        }
+        #if canImport(SceneKit)
+        let scene = try SCNScene(url: url, options: [
+            .flattenScene: false,
+            .createNormalsIfAbsent: true,
+            .convertToYUp: true,
+            .preserveOriginalTopology: true,
+        ])
+        return try Geometry(scene.rootNode)
+        #else
+        return nil
+        #endif
+    }
+
     func importFile(at path: String) throws -> Value {
         let url = try resolveURL(for: path)
         if importStack.contains(url) {
@@ -407,7 +457,7 @@ extension EvaluationContext {
             }
         default:
             do {
-                if let geometry = try delegate?.importGeometry(for: url)?.with(
+                if let geometry = try importGeometry(at: url)?.with(
                     transform: childTransform,
                     material: material,
                     sourceLocation: sourceLocation
diff --git a/ShapeScript/EvaluationDelegate.swift b/ShapeScript/EvaluationDelegate.swift
@@ -0,0 +1,20 @@
+//
+//  EvaluationDelegate.swift
+//  ShapeScript Lib
+//
+//  Created by Nick Lockwood on 29/12/2023.
+//  Copyright © 2023 Nick Lockwood. All rights reserved.
+//
+
+import Euclid
+import Foundation
+
+public protocol EvaluationDelegate: AnyObject {
+    func resolveURL(for path: String) -> URL
+    func importGeometry(for url: URL) throws -> Geometry?
+    func debugLog(_ values: [AnyHashable])
+}
+
+public extension EvaluationDelegate {
+    func importGeometry(for _: URL) throws -> Geometry? { nil }
+}
diff --git a/ShapeScript/Interpreter.swift b/ShapeScript/Interpreter.swift
@@ -13,12 +13,6 @@ import Foundation
 
 public let version = "1.8.0"
 
-public protocol EvaluationDelegate: AnyObject {
-    func resolveURL(for path: String) -> URL
-    func importGeometry(for url: URL) throws -> Geometry?
-    func debugLog(_ values: [AnyHashable])
-}
-
 public func evaluate(
     _ program: Program,
     delegate: EvaluationDelegate?,
diff --git a/ShapeScriptTests/MetadataTests.swift b/ShapeScriptTests/MetadataTests.swift
@@ -608,7 +608,6 @@ class MetadataTests: XCTestCase {
 
     func testExamplesAllRunWithoutError() {
         class TestDelegate: EvaluationDelegate {
-            func importGeometry(for _: URL) throws -> Geometry? { nil }
             func debugLog(_: [AnyHashable]) {}
 
             func resolveURL(for name: String) -> URL {
diff --git a/ShapeScriptTests/TestDelegate.swift b/ShapeScriptTests/TestDelegate.swift
@@ -17,10 +17,6 @@ class TestDelegate: EvaluationDelegate {
         self.directory = directory
     }
 
-    func importGeometry(for _: URL) throws -> Geometry? {
-        preconditionFailure()
-    }
-
     var imports = [String]()
     func resolveURL(for name: String) -> URL {
         imports.append(name)
diff --git a/Viewer/CLI/CLI.swift b/Viewer/CLI/CLI.swift
@@ -120,28 +120,6 @@ extension CLI: EvaluationDelegate {
         URL(fileURLWithPath: path, relativeTo: inputURL)
     }
 
-    func importGeometry(for url: URL) throws -> Geometry? {
-        var isDirectory: ObjCBool = false
-        _ = FileManager.default.fileExists(atPath: url.path, isDirectory: &isDirectory)
-        var url = url
-        if isDirectory.boolValue {
-            let newURL = url.appendingPathComponent(url.lastPathComponent)
-            if FileManager.default.fileExists(atPath: newURL.path) {
-                url = newURL
-            }
-        }
-        #if canImport(SceneKit)
-        let scene = try SCNScene(url: url, options: [
-            .flattenScene: false,
-            .createNormalsIfAbsent: true,
-            .convertToYUp: true,
-        ])
-        return try Geometry(scene.rootNode)
-        #else
-        return nil
-        #endif
-    }
-
     func debugLog(_ values: [AnyHashable]) {
         var spaceNeeded = false
         print(values.compactMap {
diff --git a/Viewer/Shared/Document+EvaluationDelegate.swift b/Viewer/Shared/Document+EvaluationDelegate.swift
@@ -28,44 +28,6 @@ extension Document: EvaluationDelegate {
         return url
     }
 
-    func importGeometry(for url: URL) throws -> Geometry? {
-        var isDirectory: ObjCBool = false
-        _ = FileManager.default.fileExists(atPath: url.path, isDirectory: &isDirectory)
-        var url = url
-        if isDirectory.boolValue {
-            let newURL = url.appendingPathComponent(url.lastPathComponent)
-            if FileManager.default.fileExists(atPath: newURL.path) {
-                url = newURL
-            }
-        }
-        let data = try Data(contentsOf: url)
-        switch url.pathExtension.lowercased() {
-        case "stl":
-            if let mesh = Mesh(stlData: data, materialLookup: {
-                Material(color: $0)
-            }) {
-                return Geometry(
-                    type: .mesh(mesh),
-                    name: nil,
-                    transform: .identity,
-                    material: .default,
-                    smoothing: nil,
-                    children: [],
-                    sourceLocation: nil
-                )
-            }
-        default:
-            break
-        }
-        let scene = try SCNScene(url: url, options: [
-            .flattenScene: false,
-            .createNormalsIfAbsent: true,
-            .convertToYUp: true,
-            .preserveOriginalTopology: true,
-        ])
-        return try Geometry(scene.rootNode)
-    }
-
     func debugLog(_ values: [AnyHashable]) {
         let line: String
         if values.count == 1 {
