Fix: Validation and handling of multiple settings in one parameter (#382)

Author: glx22

nml/actions/action14.py

@@ -278,9 +278,9 @@ def param_desc_actions(root, params):
                     setting_node.subnodes.append(value_names_node)
             else:
                 assert setting.type == "bool"
+                assert setting.bit_num is not None
                 setting_node.subnodes.append(BinaryNode("TYPE", 1, 1))
-                bit = setting.bit_num.value if setting.bit_num is not None else 0
-                setting_node.subnodes.append(SettingMaskNode(param_num, bit, 1))
+                setting_node.subnodes.append(SettingMaskNode(param_num, setting.bit_num.value, 1))
             if setting.def_val is not None:
                 setting_node.subnodes.append(BinaryNode("DFLT", 4, setting.def_val.value))
             param_root.subnodes.append(setting_node)

nml/ast/grf.py

@@ -305,6 +305,8 @@ def set_property(self, name, value):
 
 
 class ParameterDescription:
+    free_bits = {}
+
     def __init__(self, setting_list, num=None, pos=None):
         self.setting_list = setting_list
         self.num = num
@@ -330,15 +332,31 @@ def pre_process(self, num):
         if self.num is None:
             self.num = num
         self.num = self.num.reduce_constant()
+        if self.num.value not in ParameterDescription.free_bits:
+            ParameterDescription.free_bits[self.num.value] = list(range(0, 32))
         for setting in self.setting_list:
             setting.pre_process()
         for setting in self.setting_list:
             if setting.type == "int":
-                if len(self.setting_list) > 1:
+                if len(self.setting_list) > 1 or len(ParameterDescription.free_bits[self.num.value]) != 32:
                     raise generic.ScriptError(
-                        "When packing multiple settings in one parameter only bool settings are allowed", self.pos
+                        "When packing multiple settings in one parameter only bool settings are allowed",
+                        setting.name.pos,
                     )
                 global_constants.settings[setting.name.value] = {"num": self.num.value, "size": 4}
+                ParameterDescription.free_bits[self.num.value].clear()
             else:
-                bit = 0 if setting.bit_num is None else setting.bit_num.value
-                global_constants.misc_grf_bits[setting.name.value] = {"param": self.num.value, "bit": bit}
+                if setting.bit_num is None:
+                    if len(ParameterDescription.free_bits[self.num.value]) == 0:
+                        raise generic.ScriptError("No bits available for this parameter", setting.name.pos)
+                    setting.bit_num = expression.ConstantNumeric(ParameterDescription.free_bits[self.num.value].pop(0))
+                else:
+                    if setting.bit_num.value not in ParameterDescription.free_bits[self.num.value]:
+                        raise generic.ScriptError(
+                            "Bit {} is already used".format(setting.bit_num.value), setting.name.pos
+                        )
+                    ParameterDescription.free_bits[self.num.value].remove(setting.bit_num.value)
+                global_constants.misc_grf_bits[setting.name.value] = {
+                    "param": self.num.value,
+                    "bit": setting.bit_num.value,
+                }

regression/021_grf_parameter.nml

@@ -39,6 +39,22 @@ grf {
             };
         }
     }
+    param (2) {
+        param_NoGrid {
+            type:    bool;
+            name:    string(STR_PARAM_NOGRID);
+            desc:    string(STR_PARAM_NOGRID_DESC);
+            def_value: 1;
+        }
+    }
+    param (2) {
+        transmitter2rock {
+            type:    bool;
+            name:    string(STR_PARAM_TRANSMITTER);
+            desc:    string(STR_PARAM_TRANSMITTER_DESC);
+            def_value: 0;
+        }
+    }
 }
 
 param[10] = param_landscape;

regression/expected/021_grf_parameter.grf

@@ -7,10 +7,10 @@
 
 0 * 4 \d3
 
-1 * 817 14 "C" "INFO"
+1 * 1254 14 "C" "INFO"
 "B" "VRSN" \w4 \dx00000001
 "B" "MINV" \w4 \dx00000000
-"B" "NPAR" \w1 03
+"B" "NPAR" \w1 05
 "C" "PARA"
 "C" \d0
 "T" "NAME" 7F "Disable gridlines" 00
@@ -41,6 +41,20 @@
 00
 "B" "DFLT" \w4 \dx00000000
 00
+"C" \d3
+"T" "NAME" 7F "Disable gridlines" 00
+"T" "DESC" 7F "This setting allows to replace all ground sprites such that the landscape is painted (mostly) without grid lines. Note that roads and train tracks don't yet follow this rule" 00
+"B" "TYPE" \w1 01
+"B" "MASK" \w3 \b2 \b0 \b1
+"B" "DFLT" \w4 \dx00000001
+00
+"C" \d4
+"T" "NAME" 7F "Replace the transmitter tower by a rock" 00
+"T" "DESC" 7F "Enable to replace the transmitter tower by a rock (useful for early scenarios without telecomunication towers)" 00
+"B" "TYPE" \w1 01
+"B" "MASK" \w3 \b2 \b1 \b1
+"B" "DFLT" \w4 \dx00000000
+00
 00
 "B" "PALS" \w1 "A"
 "B" "BLTR" \w1 "8"