Add object constructor

nicklockwood · nicklockwood · commit 86d3326d818e · 2023-11-25T08:50:41.000Z
diff --git a/ShapeScript/Interpreter.swift b/ShapeScript/Interpreter.swift
@@ -899,6 +899,10 @@ extension Statement {
                     name = "color"
                     return type
                 }
+                if let type = context.options["*"] {
+                    context.options[name] = .any
+                    return type
+                }
                 return nil
             }() {
                 return try context.define(name, as: .option(
diff --git a/ShapeScript/StandardLibrary.swift b/ShapeScript/StandardLibrary.swift
@@ -547,6 +547,14 @@ extension Dictionary where Key == String, Value == Symbol {
                 in: .whitespacesAndNewlines
             ))
         },
+        // Object
+        "object": .block(.init([:], ["*": .any], .void, .any)) { context in
+            var result = [String: ShapeScript.Value]()
+            for name in context.options.keys {
+                result[name] = context.value(for: name)
+            }
+            return .object(result)
+        },
     ]
 
     static let name: Symbols = [
diff --git a/ShapeScriptTests/StandardLibraryTests.swift b/ShapeScriptTests/StandardLibraryTests.swift
@@ -999,4 +999,20 @@ class StandardLibraryTests: XCTestCase {
         let geometry = try XCTUnwrap(context.children.first?.value as? Geometry)
         XCTAssertEqual(geometry.transform.scale, Vector(1, 2, 3))
     }
+
+    // MARK: Objects
+
+    func testObjectConstructor() throws {
+        let program = try parse("""
+        define foo object {
+            bar 5
+            baz "hello"
+        }
+        print foo
+        """)
+        let delegate = TestDelegate()
+        let context = EvaluationContext(source: program.source, delegate: delegate)
+        XCTAssertNoThrow(try program.evaluate(in: context))
+        XCTAssertEqual(delegate.log, [["bar": 5, "baz": "hello"] as [String: AnyHashable]])
+    }
 }
diff --git a/docs/ios/expressions.md b/docs/ios/expressions.md
@@ -173,7 +173,7 @@ if (not a) and (b or c) {
 
 ## Members
 
-Compound values like [vectors and tuples](literals.md#vectors-and-tuples) can be decomposed by using the *dot* operator to access individual components:
+Compound values like [vectors and tuples](literals.md#vectors-and-tuples) and [objects](literals.md#objects) can be decomposed by using the *dot* operator to access individual components or *members*:
 
 ```swift
 define vector 0.5 0.2 0.4
diff --git a/docs/ios/index.md b/docs/ios/index.md
@@ -101,6 +101,7 @@ ShapeScript Help
         - [Strings](literals.md#strings)
         - [Vectors and Tuples](literals.md#vectors-and-tuples)
         - [Structured Data](literals.md#structured-data)
+        - [Objects](literals.md#objects)
     - [Symbols](symbols.md)
     - [Expressions](expressions.md)
         - [Operators](expressions.md#operators)
diff --git a/docs/ios/literals.md b/docs/ios/literals.md
@@ -196,5 +196,46 @@ for row in data {
 }
 ```
 
+## Objects
+
+For more complex [structured data](#structured-data) you can use the `object` command to create an object with arbitrary, named members:
+
+```swift
+define data object {
+    type "box"
+    width 5
+    height 10
+    depth 15
+}
+
+print data.height // prints 10
+```
+
+Objects can also be nested:
+
+```swift
+define data object {
+    type "box"
+    position 1 2 0
+    dimensions object {
+        width 5
+        height 10
+        depth 15
+    }
+}
+
+print data.dimensions.height // prints 10
+```
+
+To enumerate all the members of an object, you can use a [for loop](control-flow.md#looping-over-values). Each member is returned as a tuple of the key (member name) and value:
+
+```swift
+for row in data {
+    print "key: " row.first ", value: " row.second
+}
+```
+
+**Note:** object members are *unordered*, meaning that the order in which they are defined has no special significance. When looping through members of an object, the order will be alphabetical rather than the order in which the members were defined.
+
 ---
 [Index](index.md) | Next: [Symbols](symbols.md)
diff --git a/docs/mac/expressions.md b/docs/mac/expressions.md
@@ -173,7 +173,7 @@ if (not a) and (b or c) {
 
 ## Members
 
-Compound values like [vectors and tuples](literals.md#vectors-and-tuples) can be decomposed by using the *dot* operator to access individual components:
+Compound values like [vectors and tuples](literals.md#vectors-and-tuples) and [objects](literals.md#objects) can be decomposed by using the *dot* operator to access individual components or *members*:
 
 ```swift
 define vector 0.5 0.2 0.4
diff --git a/docs/mac/index.md b/docs/mac/index.md
@@ -101,6 +101,7 @@ ShapeScript Help
         - [Strings](literals.md#strings)
         - [Vectors and Tuples](literals.md#vectors-and-tuples)
         - [Structured Data](literals.md#structured-data)
+        - [Objects](literals.md#objects)
     - [Symbols](symbols.md)
     - [Expressions](expressions.md)
         - [Operators](expressions.md#operators)
diff --git a/docs/mac/literals.md b/docs/mac/literals.md
@@ -196,5 +196,46 @@ for row in data {
 }
 ```
 
+## Objects
+
+For more complex [structured data](#structured-data) you can use the `object` command to create an object with arbitrary, named members:
+
+```swift
+define data object {
+    type "box"
+    width 5
+    height 10
+    depth 15
+}
+
+print data.height // prints 10
+```
+
+Objects can also be nested:
+
+```swift
+define data object {
+    type "box"
+    position 1 2 0
+    dimensions object {
+        width 5
+        height 10
+        depth 15
+    }
+}
+
+print data.dimensions.height // prints 10
+```
+
+To enumerate all the members of an object, you can use a [for loop](control-flow.md#looping-over-values). Each member is returned as a tuple of the key (member name) and value:
+
+```swift
+for row in data {
+    print "key: " row.first ", value: " row.second
+}
+```
+
+**Note:** object members are *unordered*, meaning that the order in which they are defined has no special significance. When looping through members of an object, the order will be alphabetical rather than the order in which the members were defined.
+
 ---
 [Index](index.md) | Next: [Symbols](symbols.md)
diff --git a/docs/src/expressions.md b/docs/src/expressions.md
@@ -173,7 +173,7 @@ if (not a) and (b or c) {
 
 ## Members
 
-Compound values like [vectors and tuples](literals.md#vectors-and-tuples) can be decomposed by using the *dot* operator to access individual components:
+Compound values like [vectors and tuples](literals.md#vectors-and-tuples) and [objects](literals.md#objects) can be decomposed by using the *dot* operator to access individual components or *members*:
 
 ```swift
 define vector 0.5 0.2 0.4
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -101,6 +101,7 @@ ShapeScript Help
         - [Strings](literals.md#strings)
         - [Vectors and Tuples](literals.md#vectors-and-tuples)
         - [Structured Data](literals.md#structured-data)
+        - [Objects](literals.md#objects)
     - [Symbols](symbols.md)
     - [Expressions](expressions.md)
         - [Operators](expressions.md#operators)
diff --git a/docs/src/literals.md b/docs/src/literals.md
@@ -196,5 +196,46 @@ for row in data {
 }
 ```
 
+## Objects
+
+For more complex [structured data](#structured-data) you can use the `object` command to create an object with arbitrary, named members:
+
+```swift
+define data object {
+    type "box"
+    width 5
+    height 10
+    depth 15
+}
+
+print data.height // prints 10
+```
+
+Objects can also be nested:
+
+```swift
+define data object {
+    type "box"
+    position 1 2 0
+    dimensions object {
+        width 5
+        height 10
+        depth 15
+    }
+}
+
+print data.dimensions.height // prints 10
+```
+
+To enumerate all the members of an object, you can use a [for loop](control-flow.md#looping-over-values). Each member is returned as a tuple of the key (member name) and value:
+
+```swift
+for row in data {
+    print "key: " row.first ", value: " row.second
+}
+```
+
+**Note:** object members are *unordered*, meaning that the order in which they are defined has no special significance. When looping through members of an object, the order will be alphabetical rather than the order in which the members were defined.
+
 ---
 [Index](index.md) | Next: [Symbols](symbols.md)
