Merge pull request relaypro-open#9 from josefalanga/variables-declara…

…tion

Support Variable Declaration (set initial values)

examples/yarn2/declarations-metadata.csv

@@ -0,0 +1 @@
+id,node,lineNumber,tags

examples/yarn2/declarations.csv

@@ -0,0 +1,7 @@
+id,text,file,node,lineNumber
+line:C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn-Start-0,The value of test bool is {0},C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn,Start,10
+line:C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn-Start-1,The value of test number is {0},C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn,Start,11
+line:C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn-Start-2,"The value of test string is ""{0}""",C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn,Start,12
+line:C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn-Start-3,The value of test bool is {0},C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn,Start,13
+line:C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn-Start-4,The value of test number is {0},C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn,Start,14
+line:C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn-Start-5,"The value of test string is ""{0}""",C:\jose\YarnRunner-Python\examples\yarn2\declarations.yarn,Start,15

examples/yarn2/declarations.yarn

@@ -0,0 +1,16 @@
+title: Start
+---
+<<declare $testString = "initial value">>
+<<declare $testNum = 1234556>>
+<<declare $testBool = true>>
+<<declare $testStringDefault = "">>
+<<declare $testNumDefault = 0>>
+<<declare $testBoolDefault = false>>
+
+The value of test bool is {$testBool}
+The value of test number is {$testNum}
+The value of test string is "{$testString}"
+The value of test bool is {$testBoolDefault}
+The value of test number is {$testNumDefault}
+The value of test string is "{$testStringDefault}"
+===

tests/test_declarations.py

@@ -0,0 +1,26 @@
+import os
+from .context import YarnRunner
+
+compiled_yarn = open(os.path.join(os.path.dirname(
+    __file__), '../examples/yarn2/declarations.yarnc'), 'rb')
+names_csv = open(os.path.join(os.path.dirname(
+    __file__), '../examples/yarn2/declarations.csv'), 'r')
+
+runner = YarnRunner(compiled_yarn, names_csv)
+
+
+def test_variables1():
+    # variables are stored
+    assert runner.variables["$testBool"] is True
+    assert runner.variables["$testNum"] == 1234556
+    assert runner.variables["$testString"] == "initial value"
+
+    # the values get to the output without exceptions
+    assert runner.get_line() == 'The value of test bool is True'
+    assert runner.get_line() == 'The value of test number is 1234556.0'
+    assert runner.get_line() == 'The value of test string is "initial value"'
+    assert runner.get_line() == 'The value of test bool is False'
+    assert runner.get_line() == 'The value of test number is 0.0'
+    assert runner.get_line() == 'The value of test string is ""'
+
+    assert runner.has_line() is False

yarnrunner_python/runner.py

@@ -38,9 +38,21 @@ def __init__(self, compiled_yarn_f, names_csv_f, autostart=True, enable_tracing=
         self.paused = True
         self.finished = False
 
+        self.load_initial_vars()
+
         if autostart:
             self.resume()
 
+    def load_initial_vars(self):
+        for key in self._compiled_yarn.initial_values:
+            initial_value = self._compiled_yarn.initial_values[key]
+            if initial_value.HasField("string_value"):
+                self.variables[key] = initial_value.string_value
+            elif initial_value.HasField("bool_value"):
+                self.variables[key] = initial_value.bool_value
+            elif initial_value.HasField("float_value"):
+                self.variables[key] = initial_value.float_value
+
     def __construct_string_lookup_table(self):
         self.string_lookup_table = dict()
 
@@ -382,7 +394,7 @@ def __push_variable(self, instruction):
             return
 
         if variable_name not in self.variables:
-            raise Exception(f"Variable {variable_name} has not been set.")
+            raise Exception(f"Variable {variable_name} has not been set or declared.")
 
         self._vm_data_stack.insert(
             0, self.variables[variable_name])