Replace fixed-length lists with tuples

Author: HSZemi

src/genieutils/common.py

@@ -1,6 +1,6 @@
 from abc import ABC
 from enum import IntEnum
-from typing import TypeVar
+from typing import TypeVar, Sequence
 
 from genieutils.datatypes import Int, Float, String
 
@@ -45,25 +45,25 @@ def write_string(self, length: int, value: str) -> bytes:
     def write_int_8(self, value: int) -> bytes:
         return Int.to_bytes(value, length=1, signed=False)
 
-    def write_int_8_array(self, value: list[int]) -> bytes:
+    def write_int_8_array(self, value: Sequence[int]) -> bytes:
         return b''.join(self.write_int_8(v) for v in value)
 
     def write_int_16(self, value: int, signed=True) -> bytes:
         return Int.to_bytes(value, length=2, signed=signed)
 
-    def write_int_16_array(self, value: list[int]) -> bytes:
+    def write_int_16_array(self, value: Sequence[int]) -> bytes:
         return b''.join(self.write_int_16(v) for v in value)
 
     def write_int_32(self, value: int, signed=True) -> bytes:
         return Int.to_bytes(value, length=4, signed=signed)
 
-    def write_int_32_array(self, value: list[int]) -> bytes:
+    def write_int_32_array(self, value: Sequence[int]) -> bytes:
         return b''.join(self.write_int_32(v) for v in value)
 
     def write_float(self, value: float) -> bytes:
         return Float.to_bytes(value)
 
-    def write_float_array(self, value: list[float]) -> bytes:
+    def write_float_array(self, value: Sequence[float]) -> bytes:
         return b''.join(self.write_float(v) for v in value)
 
     def write_class(self, value: 'GenieClass') -> bytes:
@@ -72,7 +72,7 @@ def write_class(self, value: 'GenieClass') -> bytes:
             return retval
         return b''
 
-    def write_class_array(self, value: list['GenieClass']) -> bytes:
+    def write_class_array(self, value: Sequence['GenieClass']) -> bytes:
         retval = b''.join(self.write_class(v) for v in value)
         if retval:
             return retval
@@ -117,6 +117,48 @@ def read_int_8_array(self, size: int) -> list[int]:
             elements.append(self.read_int_8())
         return elements
 
+    def read_int_8_array_2(self) -> tuple[int, int]:
+        element_0 = self.read_int_8()
+        element_1 = self.read_int_8()
+        return element_0, element_1
+
+    def read_int_8_array_3(self) -> tuple[int, int, int]:
+        element_0 = self.read_int_8()
+        element_1 = self.read_int_8()
+        element_2 = self.read_int_8()
+        return element_0, element_1, element_2
+
+    def read_int_8_array_5(self) -> tuple[int, int, int, int, int]:
+        element_0 = self.read_int_8()
+        element_1 = self.read_int_8()
+        element_2 = self.read_int_8()
+        element_3 = self.read_int_8()
+        element_4 = self.read_int_8()
+        return element_0, element_1, element_2, element_3, element_4
+
+    def read_int_8_array_6(self) -> tuple[int, int, int, int, int, int]:
+        element_0 = self.read_int_8()
+        element_1 = self.read_int_8()
+        element_2 = self.read_int_8()
+        element_3 = self.read_int_8()
+        element_4 = self.read_int_8()
+        element_5 = self.read_int_8()
+        return element_0, element_1, element_2, element_3, element_4, element_5
+
+    def read_int_8_array_10(self) -> tuple[int, int, int, int, int, int, int, int, int, int]:
+        element_0 = self.read_int_8()
+        element_1 = self.read_int_8()
+        element_2 = self.read_int_8()
+        element_3 = self.read_int_8()
+        element_4 = self.read_int_8()
+        element_5 = self.read_int_8()
+        element_6 = self.read_int_8()
+        element_7 = self.read_int_8()
+        element_8 = self.read_int_8()
+        element_9 = self.read_int_8()
+        return (element_0, element_1, element_2, element_3, element_4, element_5, element_6, element_7, element_8,
+                element_9)
+
     def read_int_16(self, signed=True) -> int:
         return Int.from_bytes(self.consume_range(2), signed=signed)
 
@@ -126,6 +168,33 @@ def read_int_16_array(self, size: int) -> list[int]:
             elements.append(self.read_int_16())
         return elements
 
+    def read_int_16_array_2(self) -> tuple[int, int]:
+        element_0 = self.read_int_16()
+        element_1 = self.read_int_16()
+        return element_0, element_1
+
+    def read_int_16_array_3(self) -> tuple[int, int, int]:
+        element_0 = self.read_int_16()
+        element_1 = self.read_int_16()
+        element_2 = self.read_int_16()
+        return element_0, element_1, element_2
+
+    def read_int_16_array_4(self) -> tuple[int, int, int, int]:
+        element_0 = self.read_int_16()
+        element_1 = self.read_int_16()
+        element_2 = self.read_int_16()
+        element_3 = self.read_int_16()
+        return element_0, element_1, element_2, element_3
+
+    def read_int_16_array_6(self) -> tuple[int, int, int, int, int, int]:
+        element_0 = self.read_int_16()
+        element_1 = self.read_int_16()
+        element_2 = self.read_int_16()
+        element_3 = self.read_int_16()
+        element_4 = self.read_int_16()
+        element_5 = self.read_int_16()
+        return element_0, element_1, element_2, element_3, element_4, element_5
+
     def read_int_32(self, signed=True) -> int:
         return Int.from_bytes(self.consume_range(4), signed=signed)
 
@@ -135,6 +204,20 @@ def read_int_32_array(self, size: int) -> list[int]:
             elements.append(self.read_int_32())
         return elements
 
+    def read_int_32_array_10(self) -> tuple[int, int, int, int, int, int, int, int, int, int]:
+        element_0 = self.read_int_32()
+        element_1 = self.read_int_32()
+        element_2 = self.read_int_32()
+        element_3 = self.read_int_32()
+        element_4 = self.read_int_32()
+        element_5 = self.read_int_32()
+        element_6 = self.read_int_32()
+        element_7 = self.read_int_32()
+        element_8 = self.read_int_32()
+        element_9 = self.read_int_32()
+        return (element_0, element_1, element_2, element_3, element_4, element_5, element_6, element_7, element_8,
+                element_9)
+
     def read_float(self) -> float:
         return Float.from_bytes(self.consume_range(4))
 
@@ -144,6 +227,17 @@ def read_float_array(self, size: int) -> list[float]:
             elements.append(self.read_float())
         return elements
 
+    def read_float_array_2(self) -> tuple[float, float]:
+        element_0 = self.read_float()
+        element_1 = self.read_float()
+        return element_0, element_1
+
+    def read_float_array_3(self) -> tuple[float, float, float]:
+        element_0 = self.read_float()
+        element_1 = self.read_float()
+        element_2 = self.read_float()
+        return element_0, element_1, element_2
+
     def read_class(self, class_: type[C]) -> C:
         element = class_.from_bytes(self)
         return element
@@ -155,6 +249,19 @@ def read_class_array(self, class_: type[C], size: int) -> list[C]:
             elements.append(element)
         return elements
 
+    def read_class_array_3(self, class_: type[C]) -> tuple[C, C, C]:
+        element_0 = class_.from_bytes(self)
+        element_1 = class_.from_bytes(self)
+        element_2 = class_.from_bytes(self)
+        return element_0, element_1, element_2
+
+    def read_class_array_4(self, class_: type[C]) -> tuple[C, C, C, C]:
+        element_0 = class_.from_bytes(self)
+        element_1 = class_.from_bytes(self)
+        element_2 = class_.from_bytes(self)
+        element_3 = class_.from_bytes(self)
+        return element_0, element_1, element_2, element_3
+
     def read_class_array_with_pointers(self, class_: type[C], size: int, pointers: list[int]) -> list[C | None]:
         elements = []
         for i in range(size):

src/genieutils/graphic.py

@@ -88,7 +88,7 @@ class Graphic(GenieClass):
     layer: int
     player_color: int
     transparent_selection: int
-    coordinates: list[int]
+    coordinates: tuple[int, int, int, int]
     delta_count: int
     sound_id: int
     wwise_sound_id: int
@@ -116,7 +116,7 @@ def from_bytes(cls, content: ByteHandler) -> 'Graphic':
         layer = content.read_int_8()
         player_color = content.read_int_16()
         transparent_selection = content.read_int_8()
-        coordinates = content.read_int_16_array(4)
+        coordinates = content.read_int_16_array_4()
         delta_count = content.read_int_16()
         sound_id = content.read_int_16()
         wwise_sound_id = content.read_int_32()

src/genieutils/tech.py

@@ -27,8 +27,8 @@ def to_bytes(self) -> bytes:
 
 @dataclass
 class Tech(GenieClass):
-    required_techs: list[int]
-    resource_costs: list[ResearchResourceCost]
+    required_techs: tuple[int, int, int, int, int, int]
+    resource_costs: tuple[ResearchResourceCost, ResearchResourceCost, ResearchResourceCost]
     required_tech_count: int
     civ: int
     full_tech_mode: int
@@ -49,8 +49,8 @@ class Tech(GenieClass):
     @classmethod
     def from_bytes(cls, content: ByteHandler) -> 'Tech':
         return cls(
-            required_techs=content.read_int_16_array(6),
-            resource_costs=content.read_class_array(ResearchResourceCost, 3),
+            required_techs=content.read_int_16_array_6(),
+            resource_costs=content.read_class_array_3(ResearchResourceCost),
             required_tech_count=content.read_int_16(),
             civ=content.read_int_16(),
             full_tech_mode=content.read_int_16(),

src/genieutils/techtree.py

@@ -6,15 +6,15 @@
 @dataclass
 class Common(GenieClass):
     slots_used: int
-    unit_research: list[int]
-    mode: list[int]
+    unit_research: tuple[int, int, int, int, int, int, int, int, int, int]
+    mode: tuple[int, int, int, int, int, int, int, int, int, int]
 
     @classmethod
     def from_bytes(cls, content: ByteHandler) -> 'Common':
         return cls(
             slots_used=content.read_int_32(),
-            unit_research=content.read_int_32_array(10),
-            mode=content.read_int_32_array(10),
+            unit_research=content.read_int_32_array_10(),
+            mode=content.read_int_32_array_10(),
         )
 
     def to_bytes(self) -> bytes:
@@ -37,8 +37,8 @@ class TechTreeAge(GenieClass):
     techs: list[int]
     common: Common
     num_building_levels: int
-    buildings_per_zone: list[int]
-    group_length_per_zone: list[int]
+    buildings_per_zone: tuple[int, int, int, int, int, int, int, int, int, int]
+    group_length_per_zone: tuple[int, int, int, int, int, int, int, int, int, int]
     max_age_length: int
     line_mode: int
 
@@ -54,8 +54,8 @@ def from_bytes(cls, content: ByteHandler) -> 'TechTreeAge':
         techs = content.read_int_32_array(techs_count)
         common = content.read_class(Common)
         num_building_levels = content.read_int_8()
-        buildings_per_zone = content.read_int_8_array(10)
-        group_length_per_zone = content.read_int_8_array(10)
+        buildings_per_zone = content.read_int_8_array_10()
+        group_length_per_zone = content.read_int_8_array_10()
         max_age_length = content.read_int_8()
         line_mode = content.read_int_32()
         return cls(
@@ -106,8 +106,8 @@ class BuildingConnection(GenieClass):
     techs: list[int]
     common: Common
     location_in_age: int
-    units_techs_total: list[int]
-    units_techs_first: list[int]
+    units_techs_total: tuple[int, int, int, int, int]
+    units_techs_first: tuple[int, int, int, int, int]
     line_mode: int
     enabling_research: int
 
@@ -123,8 +123,8 @@ def from_bytes(cls, content: ByteHandler) -> 'BuildingConnection':
         techs = content.read_int_32_array(techs_count)
         common = content.read_class(Common)
         location_in_age = content.read_int_8()
-        units_techs_total = content.read_int_8_array(5)
-        units_techs_first = content.read_int_8_array(5)
+        units_techs_total = content.read_int_8_array_5()
+        units_techs_first = content.read_int_8_array_5()
         line_mode = content.read_int_32()
         enabling_research = content.read_int_32()
         return cls(

src/genieutils/terrainblock.py

@@ -42,8 +42,8 @@ class Terrain(GenieClass):
     blend_priority: int
     blend_type: int
     overlay_mask_name: str
-    colors: list[int]
-    cliff_colors: list[int]
+    colors: tuple[int, int, int]
+    cliff_colors: tuple[int, int]
     passable_terrain: int
     impassable_terrain: int
     is_animated: int
@@ -58,7 +58,7 @@ class Terrain(GenieClass):
     drawn: int
     frame_data: list[FrameData]
     terrain_to_draw: int
-    terrain_dimensions: list[int]
+    terrain_dimensions: tuple[int, int]
     terrain_unit_masked_density: list[int]
     terrain_unit_id: list[int]
     terrain_unit_density: list[int]
@@ -84,8 +84,8 @@ def from_bytes(cls, content: ByteHandler) -> 'Terrain':
             blend_priority=content.read_int_32(),
             blend_type=content.read_int_32(),
             overlay_mask_name=content.read_debug_string(),
-            colors=content.read_int_8_array(3),
-            cliff_colors=content.read_int_8_array(2),
+            colors=content.read_int_8_array_3(),
+            cliff_colors=content.read_int_8_array_2(),
             passable_terrain=content.read_int_8(),
             impassable_terrain=content.read_int_8(),
             is_animated=content.read_int_8(),
@@ -100,7 +100,7 @@ def from_bytes(cls, content: ByteHandler) -> 'Terrain':
             drawn=content.read_int_8(),
             frame_data=content.read_class_array(FrameData, TILE_TYPE_COUNT),
             terrain_to_draw=content.read_int_16(),
-            terrain_dimensions=content.read_int_16_array(2),
+            terrain_dimensions=content.read_int_16_array_2(),
             terrain_unit_masked_density=content.read_int_16_array(TERRAIN_UNITS_SIZE),
             terrain_unit_id=content.read_int_16_array(TERRAIN_UNITS_SIZE),
             terrain_unit_density=content.read_int_16_array(TERRAIN_UNITS_SIZE),