Feature: for token

Author: Rito13

nml/ast/for_.py

@@ -0,0 +1,75 @@
+__license__ = """
+NML is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+NML is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with NML; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA."""
+
+from nml import expression, generic, global_constants
+from nml.actions import action2, action2layout, action2real, real_sprite
+from nml.ast import base_statement
+
+
+class InArrayFor(base_statement.BaseStatement):
+    def __init__(self, array, param, expressions, pos=None):
+        base_statement.BaseStatement.__init__(self, "for", pos, False, False)
+        self.array = array
+        self.param = param
+        self.expressions = expressions
+
+
+class For(base_statement.BaseStatementList):
+    def __init__(self, name, param_list, layout_sprite_list, pos=None):
+        base_statement.BaseStatement.__init__(self, "spritelayout", pos, False, False)
+        self.initialize(name, None, len(param_list))
+        self.param_list = param_list
+        self.register_map = {}  # Set during action generation for easier referencing
+        self.layout_sprite_list = layout_sprite_list
+
+    # Do not reduce expressions here as they may contain variables
+    # And the feature is not known yet
+    def pre_process(self):
+        # Check parameter names
+        seen_names = set()
+        for param in self.param_list:
+            if not isinstance(param, expression.Identifier):
+                raise generic.ScriptError("spritelayout parameter names must be identifiers.", param.pos)
+            if param.value in seen_names:
+                raise generic.ScriptError("Duplicate parameter name '{}' encountered.".format(param.value), param.pos)
+            seen_names.add(param.value)
+        # spritelayout_base_class.pre_process(self)
+
+    def collect_references(self):
+        return []
+
+    def debug_print(self, indentation):
+        generic.print_dbg(indentation, "Sprite layout:", self.name.value)
+        generic.print_dbg(indentation + 2, "Parameters:")
+        for param in self.param_list:
+            param.debug_print(indentation + 4)
+        generic.print_dbg(indentation + 2, "Sprites:")
+        for layout_sprite in self.layout_sprite_list:
+            layout_sprite.debug_print(indentation + 4)
+
+    def __str__(self):
+        params = "" if not self.param_list else "({})".format(", ".join(str(x) for x in self.param_list))
+        return "spritelayout {}{} {{\n{}\n}}\n".format(
+            str(self.name), params, "\n".join(str(x) for x in self.layout_sprite_list)
+        )
+
+    def get_action_list(self):
+        action_list = []
+        if self.prepare_act2_output():
+            for feature in sorted(self.feature_set):
+                if feature == 0x04:
+                    continue
+                action_list.extend(action2layout.get_layout_action2s(self, feature))
+        return action_list

nml/parser.py

@@ -29,6 +29,7 @@
     disable_item,
     error,
     font,
+    for_,
     general,
     grf,
     item,
@@ -145,7 +146,8 @@ def p_main_block(self, t):
         | engine_override
         | sort_vehicles
         | basecost
-        | constant"""
+        | constant
+        | for"""
         t[0] = t[1]
 
     #
@@ -389,7 +391,9 @@ def p_property_assignment(self, t):
         """property_assignment : ID COLON expression SEMICOLON
         | ID COLON expression UNIT SEMICOLON
         | NUMBER COLON expression SEMICOLON
-        | NUMBER COLON expression UNIT SEMICOLON"""
+        | NUMBER COLON expression UNIT SEMICOLON
+        | ID COLON for SEMICOLON
+        | NUMBER COLON for SEMICOLON"""
         name = t[1]
         unit_value = None if len(t) == 5 else unit.get_unit(t[4])
         t[0] = item.Property(name, t[3], unit_value, t.lineno(1))
@@ -835,3 +839,12 @@ def p_tilelayout_item_prop(self, t):
     def p_constant(self, t):
         "constant : CONST expression EQ expression SEMICOLON"
         t[0] = constant.Constant(t[2], t[4])
+
+    def p_for(self, t):
+        """for : FOR ID LPAREN id_list RPAREN LBRACE layout_sprite_list RBRACE
+        | LBRACKET non_empty_expression_list FOR ID IN expression RBRACKET"""
+        if t[1] == "[" :
+            t[0] = for_.InArrayFor(t[6], t[4], t[2], t.lineno(1))
+        else:
+            t[0] = for_.For(t[2], t[4], t[7])
+

nml/tokens.py

@@ -61,7 +61,9 @@
     "recolour_sprite":     "RECOLOUR_SPRITE",
     "engine_override":     "ENGINE_OVERRIDE",
     "sort":                "SORT_VEHICLES",
-    "const":               "CONST"
+    "const":               "CONST",
+    "for":                 "FOR",
+    "in":                  "IN",
 }
 # fmt: on