PyLibMS 4.2.0__tar.gz → 4.2.2__tar.gz

pylibms-4.2.2/MANIFEST.in

@@ -0,0 +1 @@
+include README.md LICENSE

{pylibms-4.2.0 → pylibms-4.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.2.0
+Version: 4.2.2
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
@@ -107,7 +107,7 @@ pip install -e .
 ```
 
 # Credits & Sources
-
+* [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
   formats.
 * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general

{pylibms-4.2.0 → pylibms-4.2.2}/PyLibMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.2.0
+Version: 4.2.2
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
@@ -107,7 +107,7 @@ pip install -e .
 ```
 
 # Credits & Sources
-
+* [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
   formats.
 * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general

{pylibms-4.2.0 → pylibms-4.2.2}/README.md

@@ -86,7 +86,7 @@ pip install -e .
 ```
 
 # Credits & Sources
-
+* [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
   formats.
 * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general

{pylibms-4.2.0 → pylibms-4.2.2}/lms/flowchart/definitions/flowchart.py

@@ -16,6 +16,7 @@ class LMS_Flowchart:
             for node in entry_point.get_descendents():
                 self._nodes[node.id] = node
 
+
     def __iter__(self) -> Iterator[LMS_BaseNode]:
         return iter(self._nodes.values())
 

{pylibms-4.2.0 → pylibms-4.2.2}/lms/flowchart/definitions/node.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import string
 from collections import deque
 from types import MappingProxyType
 from typing import Generator
@@ -27,15 +28,14 @@ class LMS_BaseNode:
                  id: int | None,
                  node_type: LMS_NodeType,
                  parameter_type: LMS_NodeParameterType,
-                 parameter_value: LMS_NodeParameter | None,
-                 stream_next_id: int | None = None):
+                 parameter_value: LMS_NodeParameter | None):
         self.id = id
         self._node_type = node_type
 
         self._parameter_type = parameter_type
         self._parameter_value = parameter_value
 
-        self._stream_next_id: int | None = stream_next_id
+        self._stream_next_id: int | None = None
         self._next_node: LMS_BaseNode | None = None
 
     @property
@@ -76,14 +76,6 @@ class LMS_BaseNode:
         if not isinstance(value, self._parameter_type.builtin_type):
             raise TypeError(f"Wrong value provided! Expected {self._parameter_type.builtin_type} got {type(value)}")
 
-        sliced_datatype = {
-            LMS_NodeParameterType.PARAM_16_16: (LMS_DataType.UINT16, LMS_DataType.UINT16),
-            LMS_NodeParameterType.PARAM_16_8_8: (LMS_DataType.UINT16, LMS_DataType.UINT8, LMS_DataType.UINT8),
-            LMS_NodeParameterType.PARAM_8_8_16: (LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT16),
-            LMS_NodeParameterType.PARAM_8_8_8_8: (LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT8,
-                                                  LMS_DataType.UINT8)
-        }
-
         match self._parameter_type:
             case LMS_NodeParameterType.STRING:
                 self._parameter_value = value
@@ -92,7 +84,8 @@ class LMS_BaseNode:
                 self._parameter_value = value
             case _:
                 for i, parameter in enumerate(value):
-                    verify_number_from_datatype(parameter, sliced_datatype[self._parameter_type][i])
+                    verify_number_from_datatype(parameter,
+                                                self._parameter_type.sliced_datatype[self._parameter_type][i])
 
         self._parameter_value = value
 
@@ -100,8 +93,6 @@ class LMS_BaseNode:
         """Set the next node for the instance.
 
         :param node: the node object, None for no next node."""
-        # Once next_node is properly set, stream_id is never accessed again
-        # While it does become stale, there is no point to altering it afterward
         self._next_node = node
         return node
 
@@ -143,7 +134,6 @@ class LMS_MessageNode(LMS_BaseNode):
 
     def __init__(self,
                  id: int | None,
-                 stream_next_node: int,
                  msbt_index: int,
                  label_index: int,
                  msbt: MSBT | None = None
@@ -153,7 +143,6 @@ class LMS_MessageNode(LMS_BaseNode):
             LMS_NodeType.MESSAGE,
             LMS_NodeParameterType.NONE,
             None,
-            stream_next_node
         )
 
         self.msbt_index = msbt_index
@@ -173,7 +162,7 @@ class LMS_MessageNode(LMS_BaseNode):
     @classmethod
     def new_msbt(cls, file_index: int, entry: MSBTEntry, msbt: MSBT):
         """
-        Creates a new LMS_MessageNode given a MSBT object.
+        Creates a new ``LMS_MessageNode`` given a MSBT object.
 
         :param file_index: index of the MSBT file in a folder/archive.
         :param entry: the MSBTEntry object to reference.
@@ -211,13 +200,20 @@ class LMS_BranchNode(LMS_BaseNode):
             LMS_NodeType.BRANCH,
             parameter_type,
             parameter_value,
-            NO_NEXT_NODE
         )
 
         self._condition_id = condition_id
         self._branches: dict[int, LMS_BaseNode | None] = {}
         self._definition = definition
 
+    def __repr__(self):
+        if self._definition is None:
+            return super().__repr__()
+        return f"{self._definition.name}({ {field.name: field.value for field in self._parameter_value} } {self.id}"
+
+    def set_next_node(self, node: LMS_BaseNode | None) -> LMS_BaseNode | None:
+        raise NotImplementedError("Use function set_branch_case to alter the flow of a branch node!")
+
     @classmethod
     def new(cls,
             parameter_type: LMS_NodeParameterType,
@@ -275,6 +271,67 @@ class LMS_BranchNode(LMS_BaseNode):
         """The node branches."""
         return MappingProxyType(self._branches)
 
+    def get_case_options(self, compress_shared_references: bool = False) -> list[
+        tuple[tuple[int, ...], str, LMS_BaseNode | None]]:
+        """
+        Retrieves the cases from this node formatted with the proper messages.
+
+        If a definition is provided, and either ``case_format`` or ``case_options`` are provied, the resulting
+        message will utilize those values to format the message.
+
+        :param compress_shared_references: whether to compress shared references into one case.
+        """
+        result, case_map = [], {}
+
+        for case, branch in self._branches.items():
+            case_map.setdefault(branch, []).append(case)
+
+        if self.definition is not None:
+
+            if self.definition.case_options:
+                for case, branch in self._branches.items():
+                    case_message = self.definition.case_options.get(case, f"Case {case}")
+
+                    result.append(((case,), case_message, branch))
+
+                return result
+
+            if self.definition.case_format is not None:
+                if compress_shared_references:
+                    for branch, cases in case_map.items():
+                        case_message = self._format_case_message(merge_shared_cases(cases))
+                        result.append((tuple(cases), case_message, branch))
+                else:
+                    for case, branch in self._branches.items():
+                        case_message = self._format_case_message(case)
+                        result.append(((case,), case_message, branch))
+
+                return result
+
+        if compress_shared_references:
+            for branch, cases in case_map.items():
+                case_message = f"Case {cases[0]}" if len(cases) == 1 else f"Cases {merge_shared_cases(cases)}"
+                result.append((tuple(cases), case_message, branch))
+        else:
+            for case, branch in self._branches.items():
+                case_message = f"Case {case}"
+                result.append((case,), case_message, branch)
+
+        return result
+
+    def _format_case_message(self, case_prefix: str):
+        prefix = string.Template(self._definition.case_format)
+
+        # Unpack dict for formatting $case and $param formats
+        # Allows inserting parameter values dynamically into the case message
+        string_map = {}
+        for param_definition in self.definition.parameter_definitions:
+            string_map[param_definition.name] = self.parameter_value[
+                param_definition.name].value
+
+        string_map["case"] = case_prefix
+        return prefix.substitute(**string_map)
+
     def add_branch(self, node: LMS_BaseNode | None) -> None:
         """
         Adds a branch to the node.
@@ -345,31 +402,34 @@ class LMS_EventNode(LMS_BaseNode):
                  parameter_type: LMS_NodeParameterType,
                  parameter_value: LMS_FieldMap | int | str | tuple[int, ...],
                  action_id: int,
-                 stream_next_id: int | None = None,
                  definition: NodeDefinition | None = None,
                  ):
         super().__init__(
             id,
             LMS_NodeType.EVENT,
             parameter_type,
-            parameter_value,
-            stream_next_id)
+            parameter_value)
 
-        self._action_id = action_id
+        self._event_id = action_id
         self._definition = definition
 
+    def __repr__(self):
+        if self._definition is None:
+            return super().__repr__()
+        return f"{self._definition.name}({ {field.name: field.value for field in self._parameter_value} } {self.id}"
+
     @classmethod
-    def new(cls, parameter_type: LMS_NodeParameterType, parameter_value: int | str | tuple[int, ...], action_id: int):
+    def new(cls, parameter_type: LMS_NodeParameterType, parameter_value: int | str | tuple[int, ...], event_id: int):
         """
         Instantiates a new event node.
 
         :param parameter_type: the parameter type.
         :param parameter_value: the parameter value.
-        :param action_id: the action_id of the node.
+        :param event_id: the event_id of the node.
 
         """
         verify_parameter_structure(parameter_value, parameter_type)
-        return cls(None, parameter_type, parameter_value, action_id)
+        return cls(None, parameter_type, parameter_value, event_id)
 
     @classmethod
     def new_from_definition(cls,
@@ -399,9 +459,9 @@ class LMS_EventNode(LMS_BaseNode):
         return self._definition.name
 
     @property
-    def action_id(self) -> int:
+    def event_id(self) -> int:
         """The identifier to determine which action to run."""
-        return self._action_id
+        return self._event_id
 
 
 class LMS_EntryNode(LMS_BaseNode):
@@ -409,13 +469,12 @@ class LMS_EntryNode(LMS_BaseNode):
     Class that represents an entry node. Node that is at the start of a flowchart.
     """
 
-    def __init__(self, id: int, stream_next_id=None, flowchart_name: str = ""):
+    def __init__(self, id: int, flowchart_name: str = ""):
         super().__init__(
             id,
             LMS_NodeType.ENTRY,
             LMS_NodeParameterType.NONE,
-            None,
-            stream_next_id)
+            None)
 
         self.flowchart_name = flowchart_name
 
@@ -425,13 +484,12 @@ class LMS_JumpNode(LMS_BaseNode):
     Class that represents a jump node. Node that jumps to another flowchart.
     """
 
-    def __init__(self, id: int, next_flowchart_id: int, unknown_short0a: int):
+    def __init__(self, id: int, unknown_short0a: int):
         super().__init__(
             id,
             LMS_NodeType.JUMP,
             LMS_NodeParameterType.NONE,
-            None,
-            next_flowchart_id)
+            None)
 
         self.next_flowchart: LMS_EntryNode | None = None
 
@@ -478,3 +536,24 @@ def verify_parameter_structure(value: int | tuple[int, ...] | str, parameter_typ
     if isinstance(value, tuple) and len(value) != parameter_type.value_count:
         raise node_exceptions.LMS_NodeMissingParameterValueError(
             f"Parameter type {parameter_type} expects {parameter_type.value_count} parameter values, got {len(value)}!")
+
+
+def merge_shared_cases(cases: list[int]) -> str:
+    cases = sorted(cases)
+
+    result = []
+    start = cases[0]
+    end = cases[0]
+
+    for case in cases[1:]:
+        if case == end + 1:
+            end = case
+            continue
+
+        result.append(str(start) if start == end else f"{start}-{end}")
+
+        start = case
+        end = case
+
+    result.append(str(start) if start == end else f"{start}-{end}")
+    return ", ".join(result)

{pylibms-4.2.0 → pylibms-4.2.2}/lms/flowchart/definitions/node_type.py

@@ -54,21 +54,21 @@ class LMS_NodeParameterType(IntEnum):
     NONE = -1
 
     @property
-    def sliced_datatype(self):
-        """The parameter type split into the raw datatypes. Not valid for PARAM_32_0, PARAM_32_1, and STRING."""
+    def sliced_datatype(self) -> tuple[LMS_DataType, ...]:
+        """The parameter type split into the raw datatypes. Not valid for STRING."""
         if self in [
             LMS_NodeParameterType.NONE,
-            LMS_NodeParameterType.PARAM_32_0,
-            LMS_NodeParameterType.PARAM_32_1,
             LMS_NodeParameterType.STRING]:
             raise TypeError(f"There is no sliced datatypes for {self} parameter types!")
 
         return {
+            LMS_NodeParameterType.PARAM_32_0: (LMS_DataType.UINT32,),
             LMS_NodeParameterType.PARAM_16_16: (LMS_DataType.UINT16, LMS_DataType.UINT16),
             LMS_NodeParameterType.PARAM_16_8_8: (LMS_DataType.UINT16, LMS_DataType.UINT8, LMS_DataType.UINT8),
             LMS_NodeParameterType.PARAM_8_8_16: (LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT16),
             LMS_NodeParameterType.PARAM_8_8_8_8: (LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT8,
-                                                  LMS_DataType.UINT8)
+                                                  LMS_DataType.UINT8),
+            LMS_NodeParameterType.PARAM_32_1: (LMS_DataType.UINT32,)
         }[self]
 
     @property