Refactoring/frame (#215)

* remove return address from Frame.cs

* use concrete type

* Left string -> Name

* update pull_request_template.md

Author: Stepami

.github/pull_request_template.md

@@ -1,21 +1,8 @@
-### Description
-<!--- Describe your changes in detail -->
-<!--- Why is this change required? What problem does it solve? -->
+**Is your pull request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
+**Describe the solution you've done**
+Key points of your tech and arch decisions.
 
-### Related Issues
-<!--- If it fixes an open issue, please link to the issue here. -->
-
-
-### References
-<!--- References would be helpful to understand the changes. -->
-<!--- References can be books, links, etc. -->
-
-
-### Checklist:
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] I have followed the [contribution guidelines](../CONTRIBUTING.md) and code style for this project.
-- [ ] I have added tests covering my contributions.
-- [ ] I have updated the documentation accordingly.
-- [ ] I have added corresponding labels with respect to the part of the interpreter i've worked on.
+**Related Issues**
+If it fixes an open issue, please link to the issue here.

src/Application/HydraScript.Application.CodeGeneration/Visitors/ExpressionInstructionProvider.cs

@@ -46,7 +46,7 @@ public AddressedInstructions Visit(ArrayLiteral visitable)
     {
         var arraySize = visitable.Expressions.Count;
 
-        var arrayName = visitable.Id;
+        var arrayName = new Name(visitable.Id);
         var createArray = new CreateArray(arrayName, arraySize);
 
         var result = new AddressedInstructions { createArray };
@@ -64,7 +64,7 @@ public AddressedInstructions Visit(ArrayLiteral visitable)
             else
             {
                 result.AddRange(expression.Accept(This));
-                var last = new Name(result.OfType<Simple>().Last().Left!);
+                var last = result.OfType<Simple>().Last().Left!;
                 result.Add(new IndexAssignment(arrayName, index, last));
             }
         }
@@ -75,7 +75,7 @@ public AddressedInstructions Visit(ArrayLiteral visitable)
     public AddressedInstructions Visit(ObjectLiteral visitable)
     {
         var objectId = visitable.Id;
-        var createObject = new CreateObject(objectId);
+        var createObject = new CreateObject(new Name(objectId));
 
         var result = new AddressedInstructions { createObject };
 
@@ -89,7 +89,7 @@ public AddressedInstructions Visit(ObjectLiteral visitable)
 
     public AddressedInstructions Visit(Property visitable)
     {
-        var objectId = visitable.Object.Id;
+        var objectId = new Name(visitable.Object.Id);
 
         var (id, expression) = visitable;
         var propertyId = new Constant(id);
@@ -101,7 +101,7 @@ public AddressedInstructions Visit(Property visitable)
                 _valueDtoConverter.Convert(primary.ToValueDto()))];
 
         var instructions = expression.Accept(This);
-        var last = new Name(instructions.OfType<Simple>().Last().Left!);
+        var last = instructions.OfType<Simple>().Last().Left!;
         instructions.Add(new DotAssignment(objectId, propertyId, last));
 
         return instructions;
@@ -113,7 +113,7 @@ public AddressedInstructions Visit(UnaryExpression visitable)
             return [new Simple(visitable.Operator, _valueDtoConverter.Convert(primary.ToValueDto()))];
 
         var result = visitable.Expression.Accept(This);
-        var last = new Name(result.OfType<Simple>().Last().Left!);
+        var last = result.OfType<Simple>().Last().Left!;
         result.Add(new Simple(visitable.Operator, last));
 
         return result;
@@ -122,7 +122,7 @@ public AddressedInstructions Visit(UnaryExpression visitable)
     public AddressedInstructions Visit(BinaryExpression visitable)
     {
         if (visitable is { Left: IdentifierReference arr, Right: PrimaryExpression primary, Operator: "::" })
-            return [new RemoveFromArray(arr.Name, index: _valueDtoConverter.Convert(primary.ToValueDto()))];
+            return [new RemoveFromArray(new Name(arr), index: _valueDtoConverter.Convert(primary.ToValueDto()))];
 
         var result = new AddressedInstructions();
         IValue left, right;
@@ -132,15 +132,15 @@ public AddressedInstructions Visit(BinaryExpression visitable)
         else
         {
             result.AddRange(visitable.Left.Accept(This));
-            left = new Name(result.OfType<Simple>().Last().Left!);
+            left = result.OfType<Simple>().Last().Left!;
         }
 
         if (visitable.Right is PrimaryExpression primaryRight)
             right = _valueDtoConverter.Convert(primaryRight.ToValueDto());
         else
         {
             result.AddRange(visitable.Right.Accept(This));
-            right = new Name(result.OfType<Simple>().Last().Left!);
+            right = result.OfType<Simple>().Last().Left!;
         }
 
         result.Add(new Simple(left, visitable.Operator, right));
@@ -154,15 +154,15 @@ public AddressedInstructions Visit(CastAsExpression visitable)
             return [new AsString(_valueDtoConverter.Convert(primary.ToValueDto()))];
 
         var result = visitable.Expression.Accept(This);
-        var last = new Name(result.OfType<Simple>().Last().Left!);
+        var last = result.OfType<Simple>().Last().Left!;
         result.Add(new AsString(last));
 
         return result;
     }
 
     public AddressedInstructions Visit(WithExpression visitable)
     {
-        var objectId = visitable.ObjectLiteral.Id;
+        var objectId = new Name(visitable.ObjectLiteral.Id);
         var createObject = new CreateObject(objectId);
 
         var result = new AddressedInstructions { createObject };
@@ -188,7 +188,7 @@ public AddressedInstructions Visit(WithExpression visitable)
 
         var copyFrom = visitable.Expression is IdentifierReference objectIdent
             ? new Name(objectIdent)
-            : new Name(result.OfType<Simple>().Last().Left!);
+            : result.OfType<Simple>().Last().Left!;
 
         for (var i = 0; i < visitable.ComputedCopiedProperties.Count; i++)
         {
@@ -214,7 +214,7 @@ public AddressedInstructions Visit(ConditionalExpression visitable)
         else
         {
             result.AddRange(visitable.Test.Accept(This));
-            var last = new Name(result.OfType<Simple>().Last().Left!);
+            var last = result.OfType<Simple>().Last().Left!;
             result.Add(new IfNotGoto(last, startBlockLabel));
         }
 
@@ -227,7 +227,7 @@ public AddressedInstructions Visit(ConditionalExpression visitable)
         result.OfType<Simple>().Last().Left = temp;
         result.Add(new EndBlock(BlockType.Condition, blockId), endBlockLabel.Name);
 
-        result.Add(new Simple(new Name(temp)));
+        result.Add(new Simple(temp));
 
         return result;
     }
@@ -241,14 +241,14 @@ public AddressedInstructions Visit(AssignmentExpression visitable)
             if (last is IWriteToComplexData assignment)
                 result.Add(assignment.ToSimple());
             else
-                result.Add(new Simple(new Name(last.Left!)));
+                result.Add(new Simple(last.Left!));
         }
 
         if (visitable.Destination.Empty())
-            result.OfType<Simple>().Last().Left = visitable.Destination.Id;
+            result.OfType<Simple>().Last().Left = new Name(visitable.Destination.Id);
         else
         {
-            var last = new Name(result.OfType<Simple>().Last().Left!);
+            var last = result.OfType<Simple>().Last().Left!;
             result.AddRange(visitable.Destination.Accept(This));
             var lastRead = result.OfType<IReadFromComplexData>().Last();
             result.Replace(lastRead.ToInstruction(), lastRead.ToAssignment(last));
@@ -270,7 +270,7 @@ public AddressedInstructions Visit(DotAccess visitable)
             return [new DotRead(new Name(lhs.Id), right)];
 
         var result = visitable.Prev?.Accept(This) ?? [];
-        var left = new Name(result.OfType<Simple>().Last().Left!);
+        var left = result.OfType<Simple>().Last().Left!;
         result.Add(new DotRead(left, right));
 
         return result;
@@ -287,15 +287,15 @@ public AddressedInstructions Visit(IndexAccess visitable)
         else
         {
             result.AddRange(visitable.Index.Accept(This));
-            right = new Name(result.OfType<Simple>().Last().Left!);
+            right = result.OfType<Simple>().Last().Left!;
         }
 
         if (!visitable.HasPrev() && visitable.Parent is LeftHandSideExpression lhs)
             result.Add(new IndexRead(new Name(lhs.Id), right));
         else
         {
             result.AddRange(visitable.Prev?.Accept(This) ?? []);
-            var left = new Name(result.OfType<Simple>().Last().Left!);
+            var left = result.OfType<Simple>().Last().Left!;
             result.Add(new IndexRead(left, right));
         }
 
@@ -320,8 +320,8 @@ public AddressedInstructions Visit(CallExpression visitable)
 
         if (methodCall)
         {
-            var caller = result.Any() ? result.OfType<Simple>().Last().Left! : visitable.Id;
-            result.Add(new PushParameter(new Name(caller)));
+            var caller = result.Count > 0 ? result.OfType<Simple>().Last().Left! : new Name(visitable.Id);
+            result.Add(new PushParameter(caller));
         }
 
         for (var i = 0; i < visitable.Parameters.Count; i++)
@@ -333,7 +333,7 @@ public AddressedInstructions Visit(CallExpression visitable)
             {
                 result.AddRange(expr.Accept(This));
                 var id = result.OfType<Simple>().Last().Left!;
-                result.Add(new PushParameter(new Name(id)));
+                result.Add(new PushParameter(id));
             }
         }
 

src/Application/HydraScript.Application.CodeGeneration/Visitors/InstructionProvider.cs

@@ -107,15 +107,15 @@ public AddressedInstructions Visit(ReturnStatement visitable)
         }
 
         var result = visitable.Expression.Accept(_expressionVisitor);
-        var last = new Name(result.OfType<Simple>().Last().Left!);
+        var last = result.OfType<Simple>().Last().Left!;
         result.Add(new Return(last));
 
         return result;
     }
 
     public AddressedInstructions Visit(FunctionDeclaration visitable)
     {
-        if (!visitable.Statements.Any())
+        if (visitable.IsEmpty)
             return [];
 
         var functionInfo = new FunctionInfo(visitable.ComputedFunctionAddress);
@@ -132,7 +132,7 @@ public AddressedInstructions Visit(FunctionDeclaration visitable)
         for (var i = 0; i < visitable.Arguments.Count; i++)
         {
             var arg = visitable.Arguments[i];
-            result.Add(new PopParameter(arg.Name, arg.Info.Value));
+            result.Add(new PopParameter(new Name(arg.Name), arg.Info.Value));
         }
 
         result.AddRange(visitable.Statements.Accept(This));
@@ -160,7 +160,7 @@ public AddressedInstructions Visit(WhileStatement visitable)
         else
         {
             result.AddRange(visitable.Condition.Accept(_expressionVisitor));
-            var last = new Name(result.OfType<Simple>().Last().Left!);
+            var last = result.OfType<Simple>().Last().Left!;
             result.Add(new IfNotGoto(last, endBlockLabel));
         }
 
@@ -204,7 +204,7 @@ public AddressedInstructions Visit(IfStatement visitable)
         else
         {
             result.AddRange(visitable.Test.Accept(_expressionVisitor));
-            var last = new Name(result.OfType<Simple>().Last().Left!);
+            var last = result.OfType<Simple>().Last().Left!;
             result.Add(new IfNotGoto(last,
                 visitable.HasElseBlock()
                     ? startBlockLabel
@@ -239,11 +239,11 @@ public AddressedInstructions Visit(PrintStatement visitable)
         else
         {
             result.AddRange(visitable.Expression.Accept(_expressionVisitor));
-            var name = new Name(result.OfType<Simple>().Last().Left!);
+            var name = result.OfType<Simple>().Last().Left!;
             result.Add(new AsString(name));
         }
 
-        result.Add(new Print(new Name((result[result.End] as AsString)!.Left!)));
+        result.Add(new Print((result[result.End] as AsString)!.Left!));
 
         return result;
     }

src/Domain/HydraScript.Domain.BackEnd/AddressedInstructions.cs

@@ -4,7 +4,7 @@
 
 namespace HydraScript.Domain.BackEnd;
 
-public class AddressedInstructions : IEnumerable<IExecutableInstruction>
+public class AddressedInstructions : IReadOnlyCollection<IExecutableInstruction>
 {
     private readonly LinkedList<IAddress> _addresses = new();
     private readonly Dictionary<IAddress, LinkedListNode<IAddress>> _addressToNode = new();
@@ -85,6 +85,8 @@ public IEnumerator<IExecutableInstruction> GetEnumerator() =>
 
     IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
 
+    public int Count => _addresses.Count;
+
     public override string ToString() =>
         ZString.Join<IExecutableInstruction>('\n', this);
 }

src/Domain/HydraScript.Domain.BackEnd/Call.cs

@@ -1,11 +1,12 @@
 using HydraScript.Domain.BackEnd.Impl.Addresses;
+using HydraScript.Domain.BackEnd.Impl.Values;
 
 namespace HydraScript.Domain.BackEnd;
 
 public record Call(
     IAddress From,
     FunctionInfo To,
-    string? Where = null)
+    Name? Where = null)
 {
     public override string ToString() =>
         $"{From}: {Where} => {To.Start}: {To.Id}";

src/Domain/HydraScript.Domain.BackEnd/Frame.cs

@@ -1,11 +1,9 @@
 namespace HydraScript.Domain.BackEnd;
 
-public class Frame(IAddress returnAddress, Frame? parentFrame = null)
+public class Frame(Frame? parentFrame = null)
 {
     private readonly Dictionary<string, object?> _variables = new();
 
-    public IAddress ReturnAddress { get; } = returnAddress;
-
     public object? this[string id]
     {
         get => _variables.TryGetValue(id, out var value)

src/Domain/HydraScript.Domain.BackEnd/Impl/Instructions/PopParameter.cs

@@ -1,14 +1,17 @@
+using HydraScript.Domain.BackEnd.Impl.Values;
+
 namespace HydraScript.Domain.BackEnd.Impl.Instructions;
 
-public class PopParameter(string parameter, object? defaultValue) : Instruction
+public class PopParameter(Name parameter, object? defaultValue) : Instruction
 {
     public override IAddress? Execute(IExecuteParams executeParams)
     {
         var frame = executeParams.Frames.Peek();
-        if (executeParams.Arguments.TryDequeue(out var argument))
-            frame[parameter] = argument;
-        else
-            frame[parameter] = defaultValue;
+        parameter.Set(
+            frame,
+            executeParams.Arguments.TryDequeue(out var argument)
+                ? argument
+                : defaultValue);
         return Address.Next;
     }
 

src/Domain/HydraScript.Domain.BackEnd/Impl/Instructions/RemoveFromArray.cs

@@ -1,11 +1,13 @@
+using HydraScript.Domain.BackEnd.Impl.Values;
+
 namespace HydraScript.Domain.BackEnd.Impl.Instructions;
 
-public class RemoveFromArray(string id, IValue index) : Instruction
+public class RemoveFromArray(Name id, IValue index) : Instruction
 {
     public override IAddress? Execute(IExecuteParams executeParams)
     {
         var frame = executeParams.Frames.Peek();
-        if (frame[id] is List<object> list)
+        if (id.Get(frame) is List<object> list)
         {
             list.RemoveAt(Convert.ToInt32(index.Get(frame)));
         }

src/Domain/HydraScript.Domain.BackEnd/Impl/Instructions/Return.cs

@@ -2,16 +2,17 @@ namespace HydraScript.Domain.BackEnd.Impl.Instructions;
 
 public class Return(IValue? value = null) : Instruction
 {
-    public override IAddress Execute(IExecuteParams executeParams)
+    public override IAddress? Execute(IExecuteParams executeParams)
     {
-        var frame = executeParams.Frames.Pop();
+        var callFrame = executeParams.Frames.Pop();
         var call = executeParams.CallStack.Pop();
         if (call.Where != null && value != null)
         {
-            executeParams.Frames.Peek()[call.Where] = value.Get(frame);
+            var frame = executeParams.Frames.Peek();
+            call.Where?.Set(frame, value.Get(callFrame));
         }
 
-        return frame.ReturnAddress;
+        return call.From.Next;
     }
 
     protected override string ToStringInternal() =>

src/Domain/HydraScript.Domain.BackEnd/Impl/Instructions/WithAssignment/AsString.cs

@@ -10,11 +10,12 @@ public partial class AsString(IValue value) : Simple(value)
     {
         var frame = executeParams.Frames.Peek();
         var value = Right.right!.Get(frame);
-        frame[Left!] = value is string
+        var valueAsString = value is string
             ? value
             : JsonSerializer.Serialize(
                 value: Right.right!.Get(frame)!,
                 AsStringSerializationContext.Default.Object);
+        Left?.Set(frame, valueAsString);
 
         return Address.Next;
     }