AoE2ScenarioParser 0.3.0.dev0__tar.gz → 0.3.0.dev2__tar.gz

{aoe2scenarioparser-0.3.0.dev0 → aoe2scenarioparser-0.3.0.dev2}/AoE2ScenarioParser/datasets/trigger_lists/panel_location.py

@@ -15,7 +15,7 @@ class PanelLocation(_DataSetIntEnums):
     """
     TOP = 0
     """Panel at the top of the screen. ~13% from the top"""
-    BETWEEN = 1
+    MIDDLE = 1
     """Panel between the top and the center of the screen. ~33% from the top"""
-    CENTER = 2
+    BOTTOM = 2
     """Panel close to the center of the screen. ~45% from the top"""

{aoe2scenarioparser-0.3.0.dev0 → aoe2scenarioparser-0.3.0.dev2}/AoE2ScenarioParser/objects/managers/de/map_manager_de.py

@@ -1,4 +1,4 @@
-from typing import List
+from typing import List, Union
 
 from AoE2ScenarioParser.datasets.trigger_lists import ColorMood
 from AoE2ScenarioParser.helper.printers import warn
@@ -13,7 +13,7 @@ class MapManagerDE(MapManager):
     """Manager of all DE map related features"""
     _link_list = [
         RetrieverObjectLinkGroup("Map", group=[
-            RetrieverObjectLink("map_color_mood"),
+            RetrieverObjectLink("_map_color_mood", link="map_color_mood"),
             RetrieverObjectLink("collide_and_correct"),
             RetrieverObjectLink("villager_force_drop", support=Support(since=1.37)),
             RetrieverObjectLink("map_width"),
@@ -23,23 +23,31 @@ class MapManagerDE(MapManager):
     ]
 
     def __init__(self,
-                 map_color_mood: str,
+                 _map_color_mood: str,
                  collide_and_correct: bool,
                  villager_force_drop: bool,
                  map_width: int,
                  map_height: int,
                  terrain: List[TerrainTile],
-                 **kwargs,
-                 ):
+                 **kwargs):
         super().__init__(map_width, map_height, terrain, **kwargs)
 
-        if map_color_mood.upper() in ColorMood.__members__:
-            map_color_mood = ColorMood[map_color_mood.upper()]
+        if _map_color_mood.upper() in ColorMood.__members__:
+            map_color_mood = ColorMood[_map_color_mood.upper()]
+        else:
+            map_color_mood = _map_color_mood
 
-        self.map_color_mood: str = map_color_mood
+        self.map_color_mood: Union[str, ColorMood] = map_color_mood
         self.collide_and_correct: bool = collide_and_correct
         self.villager_force_drop: bool = villager_force_drop
 
+    @property
+    def _map_color_mood(self):
+        """Purely here to convert the Enum back to string"""
+        if isinstance(self.map_color_mood, ColorMood):
+            return self.map_color_mood.name.lower()
+        return self.map_color_mood
+
     @property
     def collide_and_correct(self):
         warn("Moved to the OptionManager. Use: `option_manager.collide_and_correct` instead", DeprecationWarning)

{aoe2scenarioparser-0.3.0.dev0 → aoe2scenarioparser-0.3.0.dev2}/AoE2ScenarioParser/objects/managers/de/xs_manager_de.py

@@ -1,10 +1,9 @@
 import tempfile
 from pathlib import Path
-from typing import Optional, Union, TYPE_CHECKING
+from typing import Optional, Union, TYPE_CHECKING, List, Tuple
 
 from AoE2ScenarioParser.datasets.effects import EffectId
 from AoE2ScenarioParser.exceptions.asp_exceptions import UnsupportedAttributeError, UnsupportedVersionError
-from AoE2ScenarioParser.helper.pretty_format import pretty_format_list
 from AoE2ScenarioParser.objects.aoe2_object import AoE2Object
 from AoE2ScenarioParser.objects.data_objects.trigger import Trigger
 from AoE2ScenarioParser.objects.support.xs_check import XsCheck
@@ -13,9 +12,8 @@ from AoE2ScenarioParser.scenarios.scenario_store.getters import get_scenario_ver
 from AoE2ScenarioParser.sections.retrievers.retriever_object_link import RetrieverObjectLink
 from AoE2ScenarioParser.sections.retrievers.support import Support
 
-
 if TYPE_CHECKING:
-    from AoE2ScenarioParser.scenarios.aoe2_de_scenario import AoE2DEScenario
+    pass
 
 
 class XsManagerDE(AoE2Object):
@@ -36,7 +34,7 @@ class XsManagerDE(AoE2Object):
         """
 
         # Instantiate the xs-check helper
-        self.xs_check = XsCheck()
+        self.xs_check = XsCheck(self._uuid)
 
         # --- XS Script Call Trigger ---
         self._initialized = False
@@ -48,9 +46,6 @@ class XsManagerDE(AoE2Object):
                         "each system once the game starts in the default0.xs file. -- Created using AoE2ScenarioParser",
         )
 
-        # Register this function to run on write
-        self.get_scenario().on_write(self.on_write_register_xs_validation)
-
     @property
     def script_name(self):
         """The XS script name to include in the scenario"""
@@ -98,7 +93,7 @@ class XsManagerDE(AoE2Object):
         self._initialized = True
         actions.import_triggers(self._uuid, [self.xs_trigger], insert_index, deepcopy=False)
 
-    def _append_to_xs(self, title, xs) -> None:
+    def _append_to_xs(self, title: str, xs: str) -> None:
         self.xs_trigger.effects[0].message += f"// {'-' * 25} {title} {'-' * 25}\n{xs}\n\n"
 
     def add_script(self, xs_file_path: str = "", xs_string: str = "", validate: bool = False):
@@ -157,28 +152,54 @@ class XsManagerDE(AoE2Object):
 
         return self.xs_check.validate(str(file.absolute()))
 
-    def on_write_register_xs_validation(self, scenario: 'AoE2DEScenario'):
+    def _get_scenario_xs(self, include_short_code: bool = False) -> str:
+        """
+        Get all XS code in the scenario from effects and conditions
+
+        Args:
+            include_short_code: If Trigger, Effect/Condition information should be prefixed to each line
+
+        Returns:
+            All XS code in the scenario (from effects and conditions)
+        """
+        scenario = self.get_scenario()
+
+        xs_snippet_map: List[Tuple[str, str]] = []
+        for trigger in scenario.trigger_manager.triggers:
+            for index, condition in enumerate(trigger.conditions):
+                if condition.xs_function:
+                    short_code = f"T{trigger.trigger_id}C{index}"
+                    xs_snippet_map.append((short_code, condition.xs_function))
+            for index, effect in enumerate(trigger.effects):
+                if effect.effect_type == EffectId.SCRIPT_CALL and effect.message != '':
+                    short_code = f"T{trigger.trigger_id}E{index}"
+                    xs_snippet_map.append((short_code, effect.message))
+
+        xs_snippets: List[str]
+        if include_short_code:
+            xs_snippets: List[str] = [
+                '\n'.join([
+                    f"/*{xs_snippet[0]}*/ {line}" if include_short_code else line
+                    for line in xs_snippet[1].splitlines()
+                ])
+                for xs_snippet in xs_snippet_map
+            ]
+        else:
+            xs_snippets = [xs_snippet[1] for xs_snippet in xs_snippet_map]
+
+        return '\n'.join(xs_snippets)
+
+    def validate_scenario_xs(self):
         if self.xs_check.is_disabled:
             return
 
-        def on_write_run_xs_validation(scenario: 'AoE2DEScenario'):
-            xs_snippets = []
-            for trigger in scenario.trigger_manager.triggers:
-                for condition in trigger.conditions:
-                    if condition.xs_function:
-                        xs_snippets.append(condition.xs_function)
-                for effect in trigger.effects:
-                    if effect.effect_type == EffectId.SCRIPT_CALL and effect.message != '':
-                        xs_snippets.append(effect.message)
+        xs_code = self._get_scenario_xs(include_short_code=True)
 
-            xs_code = '\n'.join(xs_snippets)
-            if not xs_code:
-                return
-
-            self.validate(xs=xs_code)
+        if not xs_code:
+            return
 
-        scenario.on_write(on_write_run_xs_validation)
+        self.validate(xs=xs_code)
 
     def _debug_write_script_to_file(self, filename: str = "xs.txt"):
         with open(filename, 'w') as file:
-            file.write(self.xs_trigger.effects[0].message)
+            file.write(self._get_scenario_xs())

{aoe2scenarioparser-0.3.0.dev0 → aoe2scenarioparser-0.3.0.dev2}/AoE2ScenarioParser/objects/support/xs_check.py

@@ -5,19 +5,30 @@ import tempfile
 import time
 from pathlib import Path
 from typing import Optional, Union, Tuple, Set
+from uuid import UUID
 
 from AoE2ScenarioParser import settings
+from AoE2ScenarioParser.datasets.conditions import ConditionId
+from AoE2ScenarioParser.datasets.effects import EffectId
 from AoE2ScenarioParser.exceptions.asp_exceptions import XsCheckValidationError
+from AoE2ScenarioParser.helper.pretty_format import pretty_format_name
+from AoE2ScenarioParser.helper.printers import s_print
 from AoE2ScenarioParser.helper.string_manipulations import add_tabs
+from AoE2ScenarioParser.scenarios.scenario_store import getters
 
 
 class XsCheck:
     version: Tuple[int, int, int] = (0, 1, 5)
 
-    def __init__(self):
+    def __init__(self, uuid: UUID):
+        self._uuid: UUID = uuid
+
         self.enabled = True
         self.xs_encoding = 'utf-8'
         self.allow_unsupported_versions: bool = False
+        """If XS-Check should be checked for compatibility"""
+        self.raise_on_error: bool = False
+        """If a Python error should be raised if XS-Check encounters an error"""
 
         self.path = None
         """The path for a custom XS check binary (One that is not shipped with AoE2ScenarioParser"""
@@ -65,12 +76,13 @@ class XsCheck:
                 f'You can try `xs_manager.xs_check.allow_unsupported_versions = True` to override this check'
             )
 
-    def validate(self, xs_file: Optional[Union[Path, str]]) -> True:
+    def validate(self, xs_file: Optional[Union[Path, str]], show_tmpfile: bool = True) -> True:
         """
         Validates the XS file and throws an exception if xs-check finds an error
 
         Args:
             xs_file: The XS file to validate
+            show_tmpfile: If a reference to the tmp file should be displayed
 
         Throws:
             XsCheckValidationError: When xs-check encounters an error
@@ -88,14 +100,28 @@ class XsCheck:
         if output.startswith('No errors found in file'):
             return True
 
+        # Do not show temp file name as it might be confusing
+        output = output.replace(xs_file_path, 'AoE2ScenarioParser.xs')
+
         version = '.'.join(str(v) for v in self.get_version())
 
-        print(f"\nxs-check:{version} output: [ Provided by: https://github.com/Divy1211/xs-check/ ]\n")
-        print(add_tabs(output, 1))
+        s_print('\n' + ('-' * 25) + '<[ XS-CHECK VALIDATION RESULT ]>' + ('-' * 25), final=True)
+
+        s_print(f"\nxs-check:{version} output: [ Provided by: https://github.com/Divy1211/xs-check/ ]\n", final=True)
+        s_print(add_tabs(output, 1), final=True)
+
+        self._print_parsed_xs_check_errors(output)
+
+        if show_tmpfile:
+            display_path = xs_file_path.replace('\\', '/')
+            s_print(f"\nOpen the file below to view the entire XS file:\n\tfile:///{display_path}", final=True)
 
         time.sleep(.5)
 
-        raise XsCheckValidationError("Xs-Check failed validation, see errors above", xs_check_errors=output)
+        if self.raise_on_error:
+            raise XsCheckValidationError("Xs-Check failed validation, see errors above", xs_check_errors=output)
+
+        s_print('\n' + ('-' * 25) + '<[ END XS-CHECK VALIDATION RESULT ]>' + ('-' * 25), final=True)
 
     def validate_safe(self, xs_file: Optional[Union[Path, str]]) -> True:
         """
@@ -182,7 +208,7 @@ class XsCheck:
         stderr_file, stderr_path = tempfile.mkstemp()
 
         command = [self.path, *args]
-        exitcode = subprocess.call(command, timeout=5, stdout=stdout_file, stderr=stderr_file)
+        exitcode = subprocess.call(command, timeout=60, stdout=stdout_file, stderr=stderr_file)
 
         if exitcode != 0:
             error = Path(stderr_path).read_text(encoding=self.xs_encoding)
@@ -190,3 +216,35 @@ class XsCheck:
             raise ValueError(f"A non-zero exit code ({exitcode}) was returned by xs-check: '{error}'")
 
         return Path(stdout_path).read_text(encoding=self.xs_encoding)
+
+    def _print_parsed_xs_check_errors(self, output: str) -> None:
+        # Remove unwanted characters from output (Color highlighting etc.)
+        plain_output = re.sub(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])', '', output)
+
+        prev_trigger_index = None
+        matches = re.findall(r'/\*T(\d+)([CE])(\d+)\*/', plain_output)
+
+        if len(matches) == 0:
+            return
+
+        s_print(f"\nXS-Check errors origins:\n", final=True)
+        for match in matches:
+            trigger_index, ce_type, ce_index = match
+
+            trigger = getters.get_trigger(self._uuid, int(trigger_index))
+            if ce_type == 'C':
+                obj = 'Condition'
+                type_ = trigger.conditions[int(ce_index)].condition_type
+                obj_name = pretty_format_name(ConditionId(type_).name)
+            elif ce_type == 'E':
+                obj = 'Effect'
+                type_ = trigger.effects[int(ce_index)].effect_type
+                obj_name = pretty_format_name(EffectId(type_).name)
+            else:
+                continue
+
+            if prev_trigger_index != trigger_index:
+                s_print(f"  ⇒ [Trigger #{trigger_index}] '{trigger.name}'", final=True)
+
+            s_print(f"     ↳ [{obj} #{ce_index}] {obj_name} {obj}", final=True)
+        s_print(f"", final=True)

{aoe2scenarioparser-0.3.0.dev0 → aoe2scenarioparser-0.3.0.dev2}/AoE2ScenarioParser/scenarios/aoe2_de_scenario.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from typing import Type
 
+from AoE2ScenarioParser.exceptions.asp_exceptions import XsCheckValidationError
 from AoE2ScenarioParser.objects.managers.de.map_manager_de import MapManagerDE
 from AoE2ScenarioParser.objects.managers.de.trigger_manager_de import TriggerManagerDE
 from AoE2ScenarioParser.objects.managers.de.unit_manager_de import UnitManagerDE
@@ -64,3 +65,11 @@ class AoE2DEScenario(AoE2Scenario):
             An instance of the AoE2DEScenario class which is the object representation of the given scenario file
         """
         return super().from_file(path=path, game_version=game_version, name=name)
+
+    def _internal_on_write(self, filename: str):
+        super()._internal_on_write(filename)
+
+        try:
+            self.xs_manager.validate_scenario_xs()
+        except XsCheckValidationError as e:
+            raise XsCheckValidationError(str(e), xs_check_errors=e.xs_check_errors) from None

{aoe2scenarioparser-0.3.0.dev0 → aoe2scenarioparser-0.3.0.dev2}/AoE2ScenarioParser/scenarios/aoe2_scenario.py

@@ -81,12 +81,12 @@ class AoE2Scenario:
         return tuple(map(int, self.scenario_version.split('.')))
 
     def __init__(
-        self,
-        game_version: str,
-        scenario_version: str,
-        source_location: str,
-        name: str,
-        variant: ScenarioVariant | None = None
+            self,
+            game_version: str,
+            scenario_version: str,
+            source_location: str,
+            name: str,
+            variant: ScenarioVariant | None = None
     ):
         # Scenario meta info
         self.game_version: str = game_version
@@ -119,10 +119,10 @@ class AoE2Scenario:
 
     @classmethod
     def from_file(
-        cls: Type[S],
-        path: str,
-        game_version: str,
-        name: str = ""
+            cls: Type[S],
+            path: str,
+            game_version: str,
+            name: str = ""
     ) -> S:
         """
         Creates and returns an instance of the AoE2Scenario class from the given scenario file
@@ -160,7 +160,7 @@ class AoE2Scenario:
         s_print("\n############### Attributes ###############", final=True, color="blue")
         s_print(f">>> Game version: '{scenario.game_version}'", final=True, color="blue")
         s_print(f">>> Scenario version: {scenario.scenario_version}", final=True, color="blue")
-        s_print(f">>> Scenario variant: '{variant}'", final=True, color= "blue")
+        s_print(f">>> Scenario variant: '{variant}'", final=True, color="blue")
         s_print("##########################################", final=True, color="blue")
 
         s_print(f"Loading scenario structure...", time=True, newline=True)
@@ -182,9 +182,9 @@ class AoE2Scenario:
 
     @staticmethod
     def get_scenario(
-        uuid: UUID = None,
-        obj: 'AoE2Object' = None,
-        name: str = None
+            uuid: UUID = None,
+            obj: 'AoE2Object' = None,
+            name: str = None
     ) -> S:
         """
         Get scenario through a UUID, a related object or the name of a scenario.
@@ -305,7 +305,12 @@ class AoE2Scenario:
     ####################################### Write functions ######################################
     ########################################################################################## """
 
-    def write_to_file(self, filename: str, skip_reconstruction: bool = False) -> None:
+    def write_to_file(
+            self,
+            filename: str,
+            skip_reconstruction: bool = False,
+            skip_validation: bool = False,
+    ) -> None:
         """
         Writes the scenario to a new file with the given filename
 
@@ -313,13 +318,36 @@ class AoE2Scenario:
             filename: The location to write the file to
             skip_reconstruction: If reconstruction should be skipped. If true, this will ignore all changes made
                 using the managers (For example all changes made using trigger_manager).
+            skip_validation: If validation should be skipped. If true, no blocking checks will be done when writing.
 
         Raises:
             ValueError: if the setting DISABLE_ERROR_ON_OVERWRITING_SOURCE is not disabled and the source filename is
                 the same as the filename being written to
         """
+        if not skip_validation:
+            self._validate_before_write(filename)
+
+        self._prepare_writing(filename)
         self._write_from_structure(filename, skip_reconstruction)
 
+    def _validate_before_write(self, filename: str):
+        """
+        Validates aspects of the scenario before writing the file
+
+        Args:
+            filename: The location to write the file to
+        """
+        if settings.ALLOW_OVERWRITING_SOURCE and self.source_location == filename:
+            raise ValueError("Overwriting the source scenario file is discouraged & disallowed. ")
+
+        self._validate_scenario_variant()
+
+    def _prepare_writing(self, filename: str):
+        for func in self._on_write_funcs:
+            func(self)
+
+        self._internal_on_write(filename)
+
     def _write_from_structure(self, filename: str, skip_reconstruction: bool = False) -> None:
         """
         Writes the scenario to a new file with the given filename
@@ -333,20 +361,9 @@ class AoE2Scenario:
             ValueError: if the setting DISABLE_ERROR_ON_OVERWRITING_SOURCE is not disabled and the source filename is
                 the same as the filename being written to
         """
-        if settings.ALLOW_OVERWRITING_SOURCE and self.source_location == filename:
-            raise ValueError("Overwriting the source scenario file is discouraged & disallowed. ")
-
-        for func in self._on_write_funcs:
-            func(self)
-
-        # Update the internal file name to match the output filename
-        self._update_internal_filename(filename)
-
         if not skip_reconstruction:
             self.commit()
 
-        self._validate_scenario_variant()
-
         s_print("File writing from structure started...", final=True, time=True, newline=True)
         binary = _get_file_section_data(self.sections.get('FileHeader'))
 
@@ -366,6 +383,10 @@ class AoE2Scenario:
         s_print(f"File successfully written to: " + color_string(f"'{filename}'", "magenta"), final=True, time=True)
         s_print(f"Execution time from scenario read: {etime}s", final=True, time=True)
 
+    def _internal_on_write(self, filename: str):
+        # Update the internal file name to match the output filename
+        self.sections['DataHeader'].filename = Path(filename).stem
+
     def write_error_file(self, filename: str = "error_file.txt", trail_generator: IncrementalGenerator = None) -> None:
         """
         Outputs the contents of the entire scenario file in a readable format. An example of the format is given below::
@@ -466,9 +487,6 @@ class AoE2Scenario:
         self.sections["FileHeader"].amount_of_unknown_numbers = len(dlcs)
         self.sections["FileHeader"].unknown_numbers = dlcs
 
-    def _update_internal_filename(self, filename: str) -> None:
-        self.sections['DataHeader'].filename = Path(filename).stem
-
     """ #############################################
     ################ Debug functions ################
     ############################################# """
@@ -654,7 +672,7 @@ def _get_scenario_variant(generator: IncrementalGenerator) -> ScenarioVariant |
         return None  # Unable to find sequence
 
     value = generator.file_content[index + 4:index + 8]
-    value = bytes_to_int(value, signed = False)
+    value = bytes_to_int(value, signed=False)
     try:
         return ScenarioVariant(value)
     except ValueError:

{aoe2scenarioparser-0.3.0.dev0 → aoe2scenarioparser-0.3.0.dev2}/AoE2ScenarioParser/version.py

@@ -1,4 +1,4 @@
 """ Expose version """
 
-__version__ = "0.3.0.dev0"
+__version__ = "0.3.0.dev2"
 VERSION = __version__.split(".")

{aoe2scenarioparser-0.3.0.dev0 → aoe2scenarioparser-0.3.0.dev2}/AoE2ScenarioParser.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: AoE2ScenarioParser
-Version: 0.3.0.dev0
+Version: 0.3.0.dev2
 Summary: This is a project for editing parts of an 'aoe2scenario' file from Age of Empires 2 Definitive Edition
 Author-email: Kerwin Sneijders <ksneijders-dev@hotmail.com>
 Project-URL: Homepage, https://github.com/KSneijders/AoE2ScenarioParser

{aoe2scenarioparser-0.3.0.dev0 → aoe2scenarioparser-0.3.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: AoE2ScenarioParser
-Version: 0.3.0.dev0
+Version: 0.3.0.dev2
 Summary: This is a project for editing parts of an 'aoe2scenario' file from Age of Empires 2 Definitive Edition
 Author-email: Kerwin Sneijders <ksneijders-dev@hotmail.com>
 Project-URL: Homepage, https://github.com/KSneijders/AoE2ScenarioParser

{aoe2scenarioparser-0.3.0.dev0 → aoe2scenarioparser-0.3.0.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "AoE2ScenarioParser"
-version = "0.3.0.dev0"
+version = "0.3.0.dev2"
 authors = [
     { name = "Kerwin Sneijders", email = "ksneijders-dev@hotmail.com" },
 ]