Merge pull request #262 from stevehalliwell/dyn-prop

Merge dyn-prop into main: Add support for dynamically using fields

README.md

@@ -309,6 +309,12 @@ class MyFooAndThenSome
 var matchingShape1 = anAddress meets Address(); //will be true
 var matchingShape2 = anAddress meets myFoo(); //will be false
 
+//ulox also supports the use of fields via subscript syntax.
+//  This allows for code that does not know the identifier ahead
+//  of time to be written.
+var someFieldNameWeDidntKnow = "a";
+myFoo[someFieldNameWeDidntKnow] = 7; 
+
 //testing is built into the language, 
 //  they are setup like test fixtures with test cases.
 //  They are auto run by the vm, in an isolated inner vm. 

ulox/ulox.core.tests/DynamicTests.cs

@@ -101,5 +101,71 @@ public void Dyanic_RemoveFieldWhenReadOnly_ShouldError()
 
             StringAssert.StartsWith("Cannot remove field from read only", testEngine.InterpreterResult);
         }
+
+        [Test]
+        public void DyanicProperty_GetExists_ShouldMatch()
+        {
+            testEngine.Run(@"
+var foo = { a = 1 };
+var res = foo[""a""];
+print(res);");
+
+            Assert.AreEqual("1", testEngine.InterpreterResult);
+        }
+
+        [Test]
+        public void DyanicProperty_GetDoesNotExists_ShouldError()
+        {
+            testEngine.Run(@"
+var foo = { a = 1 };
+var res = foo[""b""];
+print(res);");
+
+            StringAssert.StartsWith("No field of name 'b' could be found on instance", testEngine.InterpreterResult);
+        }
+
+        [Test]
+        public void DyanicProperty_GetInvalidType_ShouldError()
+        {
+            testEngine.Run(@"
+var foo = 7;
+var res = foo[""b""];
+print(res);");
+
+            StringAssert.StartsWith("Cannot perform get index on type 'Double'", testEngine.InterpreterResult);
+        }
+
+        [Test]
+        public void DyanicProperty_SetExists_ShouldMatch()
+        {
+            testEngine.Run(@"
+var foo = { a = 1 };
+foo[""a""] = 2;
+print(foo.a);");
+
+            Assert.AreEqual("2", testEngine.InterpreterResult);
+        }
+
+        [Test]
+        public void DyanicProperty_SetDoesNotExists_ShouldError()
+        {
+            testEngine.Run(@"
+var foo = { a = 1 };
+foo[""b""] = 2;
+print(foo.a);");
+
+            StringAssert.StartsWith("Attempted to create a new entry 'b' via Set.", testEngine.InterpreterResult);
+        }
+
+        [Test]
+        public void DyanicProperty_SetInvalidType_ShouldError()
+        {
+            testEngine.Run(@"
+var foo = 7;
+foo[""b""] = 2;
+print(foo.a);");
+
+            StringAssert.StartsWith("Cannot perform set index on type 'Double'", testEngine.InterpreterResult);
+        }
     }
 }

ulox/ulox.core.tests/JsonSerialisationTests.cs

@@ -222,5 +222,83 @@ public void DeserialiseViaLibrary_WhenGivenKnownArray_ShouldReturnExpectedOutput
 
             Assert.AreEqual("", testEngine.InterpreterResult);
         }
+
+        [Test]
+        public void SerialiseToJson_WhenComplextDataStore_ShouldBeSuccess()
+        {
+            testEngine.Run(@"
+class ShipCharacter
+{
+var
+    accel = 20,
+    throttleAccel = 2,
+    maxSpeed = 12,
+    turnPerSecondThrust = 190,
+    turnPerSecondFreeSpin = 290,
+    gravity = 10,
+    dragSharpness = 0.5,
+    sidewaysDragSharpness = 3,
+    backwardDragSharpness = 1.5,
+    mass = 1,
+    fireRate = 0.5,
+    kickback = 1,
+    projectileSpeed = 10,
+    projectileTtl = 1,
+    projectileSpeedInher = 0.5,
+    maxHealth = 5,
+    invulnTime = -1, 
+    timeTilRegen = 0,
+    healthRegenRate = -1,
+    healthRegenFreeSpinRate = -1,
+    shotName = ""PlayerSmallShot"",
+    weaponType = ""PlayerBullet"",
+    weaponCreator = fun(fromShip){},
+    pipLifetime = 20,
+    pipPickupRange = 1,
+    pipAttractRange = 15,
+    pipAttractForce = 20,
+    pipsWhenDestroyed = 0,
+    sizeRadius = 1,
+    waterDisplacement = 20,
+    rudderAccel = 2,
+}
+
+var enemyShipData = 
+{
+    EnemyA = ShipCharacter() update 
+    {
+        fireRate = 1,
+        accel = 25,
+        maxSpeed = 14,
+        turnPerSecondThrust = 290,
+        turnPerSecondNoThrust = 380,
+        shotName = ""EnemySmallShot"",
+        weaponType = ""EnemyBullet"",
+        pipsWhenDestroyed = 1,
+        sizeRadius = 0.25,
+        waterDisplacement = 5,
+        rudderAccel = 3,
+    },
+    EnemyB = ShipCharacter() update 
+    {
+        fireRate = 0.2,
+        accel = 15,
+        maxSpeed = 9,
+        shotName = ""EnemySmallShot"",
+        weaponType = ""EnemyBullet"",
+        projectileSpeed = 15,
+        projectileSpeedInher = 1,
+        pipsWhenDestroyed = 2,
+        sizeRadius = 1.5,
+        waterDisplacement = 10,
+        rudderAccel = 1,
+    },
+};
+
+print(Serialise.ToJson(enemyShipData));
+");
+
+            StringAssert.StartsWith("{\r\n  \"EnemyA\": {\r\n    \"accel\": 25.0,", testEngine.InterpreterResult);
+        }
     }
 }

ulox/ulox.core.tests/SimpleStringSerialisationTests.cs

@@ -1,6 +1,5 @@
 using NUnit.Framework;
 using System.Text.RegularExpressions;
-using ULox;
 
 namespace ULox.Core.Tests
 {

ulox/ulox.core/Package/Runtime/Engine/VM.cs

@@ -483,15 +483,30 @@ public InterpreterResult Run()
 
                 case OpCode.GET_INDEX:
                 {
-                    var (index, listValue) = Pop2OrLocals(packet.b1, packet.b2);
+                    var (indexOrName, targetValue) = Pop2OrLocals(packet.b1, packet.b2);
                     var res = Value.Null();
-                    if (listValue.val.asInstance is INativeCollection nativeCol)
+                    if (targetValue.type == ValueType.Instance)
                     {
-                        res = nativeCol.Get(index);
+                        if (targetValue.val.asInstance is INativeCollection nativeCol)
+                        {
+                            res = nativeCol.Get(indexOrName);
+                        }
+                        else
+                        {
+                            var instance = targetValue.val.asInstance;
+                            if (instance.Fields.Get(indexOrName.val.asString, out res))
+                            {
+                                Push(res);
+                            }
+                            else
+                            {
+                                ThrowRuntimeException($"No field of name '{indexOrName.val.asString}' could be found on instance '{instance}'");
+                            }
+                        }
                     }
                     else
                     {
-                        ThrowRuntimeException($"Cannot perform get index on type '{listValue.type}'");
+                        ThrowRuntimeException($"Cannot perform get index on type '{targetValue.type}'");
                     }
 
                     SetLocalFromB3(packet.b3, res);
@@ -502,7 +517,7 @@ public InterpreterResult Run()
                 case OpCode.SET_INDEX:
                 {
                     var (newValue, index, listValue) = Pop3OrLocals(packet.b1, packet.b2, packet.b3);
-                    DoSetIndexOp(opCode, newValue, index, listValue);
+                    DoSetIndexOp(newValue, index, listValue);
                 }
                 break;
 
@@ -671,16 +686,25 @@ private void DoTypeOfOp()
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        private void DoSetIndexOp(OpCode opCode, Value newValue, Value index, Value listValue)
+        private void DoSetIndexOp(Value newValue, Value indexOrName, Value target)
         {
-            if (listValue.val.asInstance is INativeCollection nativeCol)
+            if (target.type == ValueType.Instance)
             {
-                nativeCol.Set(index, newValue);
+                if (target.val.asInstance is INativeCollection nativeCol)
+                {
+                    nativeCol.Set(indexOrName, newValue);
+                }
+                else
+                {
+                    var inst = target.val.asInstance;
+                    inst.Fields.Set(indexOrName.val.asString, newValue);
+                }
+
                 Push(newValue);
                 return;
             }
 
-            ThrowRuntimeException($"Cannot perform set index on type '{listValue.type}'");
+            ThrowRuntimeException($"Cannot perform set index on type '{target.type}'");
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]

ulox/ulox.core/Package/Runtime/Library/Serialise/ValueHeirarchyWalker.cs

@@ -52,12 +52,17 @@ private void WalkField(HashedString name, Value v)
 
                 break;
 
-            default:
+            case ValueType.Double:
+            case ValueType.Bool:
+            case ValueType.String:
+            case ValueType.Null:
                 if (name != null)
                     _writer.WriteNameAndValue(name.String, v);
                 else
                     _writer.WriteValue(v);
 
+                break;
+            default:
                 break;
             }
         }