Skip to content

Commit

Permalink
when retrieving a nested array/dictionary from a by-reference diction…
Browse files Browse the repository at this point in the history 
…ary, return it by-reference (#460)
  • Loading branch information
@Jamiras
Jamiras authored Apr 12, 2024
1 parent 77c3b56 commit 3446600
Show file tree
Hide file tree
Showing 6 changed files with 205 additions and 76 deletions.
31 changes: 25 additions & 6 deletions Source/Parser/Expressions/IndexedVariableExpression.cs
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System.Collections.Generic;
using RATools.Data;
using System.Collections.Generic;
using System.Text;

namespace RATools.Parser.Expressions
Expand Down Expand Up @@ -43,15 +44,16 @@ public override ExpressionBase GetValue(InterpreterScope scope)
{
StringBuilder builder;
ExpressionBase container, index, result;
bool isReference;

GetContainerIndex(scope, out container, out index);
GetContainerIndex(scope, out container, out index, out isReference);

switch (container.Type)
{
case ExpressionType.Dictionary:
result = ((DictionaryExpression)container).GetEntry(index);
if (result != null)
return result;
break;

builder = new StringBuilder();
builder.Append("No entry in dictionary for key: ");
Expand All @@ -60,7 +62,8 @@ public override ExpressionBase GetValue(InterpreterScope scope)

case ExpressionType.Array:
// ASSERT: index was validated in GetContainerIndex
return ((ArrayExpression)container).Entries[((IntegerConstantExpression)index).Value];
result = ((ArrayExpression)container).Entries[((IntegerConstantExpression)index).Value];
break;

case ExpressionType.Error:
return container;
Expand All @@ -74,12 +77,22 @@ public override ExpressionBase GetValue(InterpreterScope scope)
builder.Append(')');
return new ErrorExpression(builder.ToString(), Variable);
}

if (isReference && VariableReferenceExpression.CanReference(result.Type))
{
builder = new StringBuilder();
AppendString(builder);
result = new VariableReferenceExpression(new VariableDefinitionExpression(builder.ToString()), result);
}

return result;
}

public ErrorExpression Assign(InterpreterScope scope, ExpressionBase newValue)
{
ExpressionBase container, index;
GetContainerIndex(scope, out container, out index);
bool isReference;
GetContainerIndex(scope, out container, out index, out isReference);

switch (container.Type)
{
Expand Down Expand Up @@ -108,8 +121,11 @@ public ErrorExpression Assign(InterpreterScope scope, ExpressionBase newValue)
return null;
}

private void GetContainerIndex(InterpreterScope scope, out ExpressionBase container, out ExpressionBase index)
private void GetContainerIndex(InterpreterScope scope,
out ExpressionBase container, out ExpressionBase index, out bool isReference)
{
isReference = false;

if (Index.Type == ExpressionType.FunctionCall)
{
var expression = (FunctionCallExpression)Index;
Expand All @@ -131,7 +147,10 @@ private void GetContainerIndex(InterpreterScope scope, out ExpressionBase contai

var variableReference = container as VariableReferenceExpression;
if (variableReference != null)
{
container = variableReference.Expression;
isReference = true;
}

var array = container as ArrayExpression;
if (array != null)
Expand Down
16 changes: 15 additions & 1 deletion Source/Parser/Expressions/VariableExpression.cs
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using RATools.Data;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
Expand Down Expand Up @@ -89,7 +90,7 @@ public virtual ExpressionBase GetValue(InterpreterScope scope)
// when a parameter is assigned to a variable that is an array or dictionary,
// assume it has already been evaluated and pass it by reference. this is magnitudes
// more performant, and allows the function to modify the data in the container.
if (value.Type == ExpressionType.Dictionary || value.Type == ExpressionType.Array)
if (VariableReferenceExpression.CanReference(value.Type))
{
var reference = scope.GetVariableReference(Name);
CopyLocation(reference);
Expand Down Expand Up @@ -223,5 +224,18 @@ internal override void AppendString(StringBuilder builder)
{
builder.Append(Variable.Name);
}

internal static bool CanReference(ExpressionType type)
{
switch (type)
{
case ExpressionType.Dictionary:
case ExpressionType.Array:
return true;

default:
return false;
}
}
}
}
24 changes: 23 additions & 1 deletion Tests/Parser/Functions/ArrayMapFunctionTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using RATools.Parser.Expressions;
using RATools.Parser.Functions;
using System.Linq;
using System.Text;

namespace RATools.Parser.Tests.Functions
{
Expand Down Expand Up @@ -30,7 +31,7 @@ private static string Evaluate(string input)
scope.Context = new AssignmentExpression(new VariableExpression("t"), expr);
if (funcCall.Evaluate(scope, out expr))
{
var builder = new System.Text.StringBuilder();
var builder = new StringBuilder();
expr.AppendString(builder);
return builder.ToString();
}
Expand All @@ -50,6 +51,27 @@ public void TestSimple()
Is.EqualTo("[byte(0x000001), byte(0x000002), byte(0x000003)]"));
}

[Test]
public void TestNested()
{
var scope = new InterpreterScope(AchievementScriptInterpreter.GetGlobalScope());
var array = new ArrayExpression();
array.Entries.Add(new IntegerConstantExpression(1));
array.Entries.Add(new IntegerConstantExpression(2));
array.Entries.Add(new IntegerConstantExpression(3));
var dict = new DictionaryExpression();
var key = new IntegerConstantExpression(0);
dict.Add(key, array);
scope.DefineVariable(new VariableDefinitionExpression("dict"), dict);

var result = FunctionTests.Evaluate<ArrayMapFunction>("array_map(dict[0], a => byte(a))", scope);
Assert.That(result, Is.Not.Null);

var builder = new StringBuilder();
result.AppendString(builder);
Assert.That(builder.ToString(), Is.EqualTo("[byte(0x000001), byte(0x000002), byte(0x000003)]"));
}

[Test]
public void TestSingleElement()
{
Expand Down
72 changes: 39 additions & 33 deletions Tests/Parser/Functions/ArrayPopFunctionTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,39 +18,14 @@ public void TestDefinition()
Assert.That(def.Parameters.ElementAt(0).Name, Is.EqualTo("array"));
}

private ExpressionBase Evaluate(string input, InterpreterScope scope, string expectedError = null)
private static ExpressionBase Evaluate(string input, InterpreterScope scope)
{
var funcDef = new ArrayPopFunction();

var expression = ExpressionBase.Parse(new PositionalTokenizer(Tokenizer.CreateTokenizer(input)));
Assert.That(expression, Is.InstanceOf<FunctionCallExpression>());
var funcCall = (FunctionCallExpression)expression;

ExpressionBase error;
var parameterScope = funcCall.GetParameters(funcDef, scope, out error);

if (expectedError == null)
{
Assert.That(error, Is.Null);

ExpressionBase result;
Assert.That(funcDef.Evaluate(parameterScope, out result), Is.True);
return result;
}
else
{
if (error == null)
Assert.That(funcDef.Evaluate(parameterScope, out error), Is.False);

Assert.That(error, Is.InstanceOf<ErrorExpression>());

var parseError = (ErrorExpression)error;
while (parseError.InnerError != null)
parseError = parseError.InnerError;
Assert.That(parseError.Message, Is.EqualTo(expectedError));
return FunctionTests.Evaluate<ArrayPopFunction>(input, scope);
}

return null;
}
private static void AssertEvaluateError(string input, InterpreterScope scope, string expectedError)
{
FunctionTests.AssertEvaluateError<ArrayPopFunction>(input, scope, expectedError);
}

[Test]
Expand Down Expand Up @@ -81,12 +56,43 @@ public void TestSimple()
Assert.That(array.Entries.Count, Is.EqualTo(0));
}

[Test]
public void TestNested()
{
var scope = new InterpreterScope();
var array = new ArrayExpression();
array.Entries.Add(new IntegerConstantExpression(1));
array.Entries.Add(new IntegerConstantExpression(2));
var dict = new DictionaryExpression();
var key = new IntegerConstantExpression(0);
dict.Add(key, array);
scope.DefineVariable(new VariableDefinitionExpression("dict"), dict);

var entry = Evaluate("array_pop(dict[0])", scope);
Assert.That(entry, Is.InstanceOf<IntegerConstantExpression>());
Assert.That(((IntegerConstantExpression)entry).Value, Is.EqualTo(2));
Assert.That(array.Entries.Count, Is.EqualTo(1));
Assert.That(array.Entries[0], Is.InstanceOf<IntegerConstantExpression>());
Assert.That(((IntegerConstantExpression)array.Entries[0]).Value, Is.EqualTo(1));

entry = Evaluate("array_pop(dict[0])", scope);
Assert.That(entry, Is.InstanceOf<IntegerConstantExpression>());
Assert.That(((IntegerConstantExpression)entry).Value, Is.EqualTo(1));
Assert.That(array.Entries.Count, Is.EqualTo(0));

// empty array always returns 0
entry = Evaluate("array_pop(dict[0])", scope);
Assert.That(entry, Is.InstanceOf<IntegerConstantExpression>());
Assert.That(((IntegerConstantExpression)entry).Value, Is.EqualTo(0));
Assert.That(array.Entries.Count, Is.EqualTo(0));
}

[Test]
public void TestUndefined()
{
var scope = new InterpreterScope();

Evaluate("array_pop(arr)", scope, "Unknown variable: arr");
AssertEvaluateError("array_pop(arr)", scope, "Unknown variable: arr");
}

[Test]
Expand All @@ -97,7 +103,7 @@ public void TestDictionary()
dict.Add(new IntegerConstantExpression(1), new StringConstantExpression("One"));
scope.DefineVariable(new VariableDefinitionExpression("dict"), dict);

Evaluate("array_push(dict)", scope, "array: Cannot convert dictionary to array");
AssertEvaluateError("array_pop(dict)", scope, "array: Cannot convert dictionary to array");
}

[Test]
Expand Down
69 changes: 34 additions & 35 deletions Tests/Parser/Functions/ArrayPushFunctionTests.cs
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
using Jamiras.Components;
using NUnit.Framework;
using NUnit.Framework;
using RATools.Data;
using RATools.Parser.Expressions;
using RATools.Parser.Expressions.Trigger;
Expand All @@ -21,37 +20,14 @@ public void TestDefinition()
Assert.That(def.Parameters.ElementAt(1).Name, Is.EqualTo("value"));
}

private void Evaluate(string input, InterpreterScope scope, string expectedError = null)
private static void Evaluate(string input, InterpreterScope scope)
{
var funcDef = new ArrayPushFunction();

var expression = ExpressionBase.Parse(new PositionalTokenizer(Tokenizer.CreateTokenizer(input)));
Assert.That(expression, Is.InstanceOf<FunctionCallExpression>());
var funcCall = (FunctionCallExpression)expression;

ExpressionBase error;
var parameterScope = funcCall.GetParameters(funcDef, scope, out error);

if (expectedError == null)
{
Assert.That(error, Is.Null);

ExpressionBase result;
Assert.That(funcDef.Evaluate(parameterScope, out result), Is.True);
Assert.That(result, Is.Null);
}
else
{
if (error == null)
Assert.That(funcDef.Evaluate(parameterScope, out error), Is.False);

Assert.That(error, Is.InstanceOf<ErrorExpression>());

var parseError = (ErrorExpression)error;
while (parseError.InnerError != null)
parseError = parseError.InnerError;
Assert.That(parseError.Message, Is.EqualTo(expectedError));
}
FunctionTests.Execute<ArrayPushFunction>(input, scope);
}

private static void AssertEvaluateError(string input, InterpreterScope scope, string expectedError)
{
FunctionTests.AssertEvaluateError<ArrayPushFunction>(input, scope, expectedError);
}

[Test]
Expand All @@ -74,12 +50,35 @@ public void TestSimple()
Assert.That(((StringConstantExpression)array.Entries[1]).Value, Is.EqualTo("2"));
}

[Test]
public void TestNested()
{
var scope = new InterpreterScope();
var array = new ArrayExpression();
var dict = new DictionaryExpression();
var key = new IntegerConstantExpression(0);
dict.Add(key, array);
scope.DefineVariable(new VariableDefinitionExpression("dict"), dict);

Evaluate("array_push(dict[0], 1)", scope);
Assert.That(array.Entries.Count, Is.EqualTo(1));
Assert.That(array.Entries[0], Is.InstanceOf<IntegerConstantExpression>());
Assert.That(((IntegerConstantExpression)array.Entries[0]).Value, Is.EqualTo(1));

Evaluate("array_push(dict[0], \"2\")", scope);
Assert.That(array.Entries.Count, Is.EqualTo(2));
Assert.That(array.Entries[0], Is.InstanceOf<IntegerConstantExpression>());
Assert.That(((IntegerConstantExpression)array.Entries[0]).Value, Is.EqualTo(1));
Assert.That(array.Entries[1], Is.InstanceOf<StringConstantExpression>());
Assert.That(((StringConstantExpression)array.Entries[1]).Value, Is.EqualTo("2"));
}

[Test]
public void TestUndefined()
{
var scope = new InterpreterScope();

Evaluate("array_push(arr, 1)", scope, "Unknown variable: arr");
AssertEvaluateError("array_push(arr, 1)", scope, "Unknown variable: arr");
}

[Test]
Expand All @@ -89,10 +88,10 @@ public void TestDictionary()
var dict = new DictionaryExpression();
scope.DefineVariable(new VariableDefinitionExpression("dict"), dict);

Evaluate("array_push(dict, 1)", scope, "array: Cannot convert dictionary to array");
AssertEvaluateError("array_push(dict, 1)", scope, "array: Cannot convert dictionary to array");
}

private void AddHappyFunction(InterpreterScope scope)
private static void AddHappyFunction(InterpreterScope scope)
{
scope.AddFunction(UserFunctionDefinitionExpression.ParseForTest(
"function happy(num1) => num1"
Expand Down
Loading

0 comments on commit 3446600

Please sign in to comment.