splat64 0.32.0__tar.gz → 0.32.2__tar.gz

{splat64-0.32.0 → splat64-0.32.2}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # splat Release Notes
 
+### 0.32.2
+
+* Fix jumptable labels not being properly formatted with the given `symbol_name_format`.
+* `spimdisasm` 1.32.0 or above is now required.
+
+### 0.32.1
+
+* Include subsegment information when aggregating split statistics.
+
 ### 0.32.0
 
 * Tag `PSYQ` as a compiler that uses `j` instructions as branches.

{splat64-0.32.0 → splat64-0.32.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: splat64
-Version: 0.32.0
+Version: 0.32.2
 Summary: A binary splitting tool to assist with decompilation and modding projects
 Project-URL: Repository, https://github.com/ethteck/splat
 Project-URL: Issues, https://github.com/ethteck/splat/issues
@@ -26,6 +26,7 @@ License: MIT License
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
+License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.9
@@ -41,7 +42,7 @@ Requires-Dist: mypy; extra == 'dev'
 Requires-Dist: n64img>=0.3.3; extra == 'dev'
 Requires-Dist: pygfxd; extra == 'dev'
 Requires-Dist: rabbitizer<2.0.0,>=1.12.0; extra == 'dev'
-Requires-Dist: spimdisasm<2.0.0,>=1.31.0; extra == 'dev'
+Requires-Dist: spimdisasm<2.0.0,>=1.32.0; extra == 'dev'
 Requires-Dist: types-colorama; extra == 'dev'
 Requires-Dist: types-pyyaml; extra == 'dev'
 Provides-Extra: mips
@@ -49,7 +50,7 @@ Requires-Dist: crunch64<1.0.0,>=0.5.1; extra == 'mips'
 Requires-Dist: n64img>=0.3.3; extra == 'mips'
 Requires-Dist: pygfxd; extra == 'mips'
 Requires-Dist: rabbitizer<2.0.0,>=1.12.0; extra == 'mips'
-Requires-Dist: spimdisasm<2.0.0,>=1.31.0; extra == 'mips'
+Requires-Dist: spimdisasm<2.0.0,>=1.32.0; extra == 'mips'
 Description-Content-Type: text/markdown
 
 # splat
@@ -75,7 +76,7 @@ The brackets corresponds to the optional dependencies to install while installin
 If you use a `requirements.txt` file in your repository, then you can add this library with the following line:
 
 ```txt
-splat64[mips]>=0.32.0,<1.0.0
+splat64[mips]>=0.32.2,<1.0.0
 ```
 
 ### Optional dependencies

{splat64-0.32.0 → splat64-0.32.2}/README.md

@@ -21,7 +21,7 @@ The brackets corresponds to the optional dependencies to install while installin
 If you use a `requirements.txt` file in your repository, then you can add this library with the following line:
 
 ```txt
-splat64[mips]>=0.32.0,<1.0.0
+splat64[mips]>=0.32.2,<1.0.0
 ```
 
 ### Optional dependencies

{splat64-0.32.0 → splat64-0.32.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "splat64"
 # Should be synced with src/splat/__init__.py
-version = "0.32.0"
+version = "0.32.2"
 description = "A binary splitting tool to assist with decompilation and modding projects"
 readme = "README.md"
 license = {file = "LICENSE"}
@@ -20,7 +20,7 @@ dependencies = [
 
 [project.optional-dependencies]
 mips = [
-    "spimdisasm>=1.31.0,<2.0.0", # This value should be keep in sync with the version listed on disassembler/spimdisasm_disassembler.py
+    "spimdisasm>=1.32.0,<2.0.0", # This value should be keep in sync with the version listed on disassembler/spimdisasm_disassembler.py
     "rabbitizer>=1.12.0,<2.0.0",
     "pygfxd",
     "n64img>=0.3.3",
@@ -46,5 +46,8 @@ build-backend = "hatchling.build"
 [tool.hatch.build.targets.wheel]
 packages = ["src/splat"]
 
+[tool.hatch.envs.dev]
+features = ["dev"]
+
 [project.scripts]
 splat = "splat.__main__:splat_main"

{splat64-0.32.0 → splat64-0.32.2}/requirements.txt

@@ -4,7 +4,7 @@ tqdm
 intervaltree
 colorama
 # This value should be keep in sync with the version listed on disassembler/spimdisasm_disassembler.py and pyproject.toml
-spimdisasm>=1.31.0
+spimdisasm>=1.32.0
 rabbitizer>=1.10.0
 pygfxd
 n64img>=0.1.4

{splat64-0.32.0 → splat64-0.32.2}/src/splat/__init__.py

@@ -1,7 +1,7 @@
 __package_name__ = __name__
 
 # Should be synced with pyproject.toml
-__version__ = "0.32.0"
+__version__ = "0.32.2"
 __author__ = "ethteck"
 
 from . import util as util

{splat64-0.32.0 → splat64-0.32.2}/src/splat/disassembler/spimdisasm_disassembler.py

@@ -7,7 +7,7 @@ from typing import Set
 
 class SpimdisasmDisassembler(disassembler.Disassembler):
     # This value should be kept in sync with the version listed on requirements.txt and pyproject.toml
-    SPIMDISASM_MIN = (1, 31, 0)
+    SPIMDISASM_MIN = (1, 32, 0)
 
     def configure(self):
         # Configure spimdisasm

{splat64-0.32.0 → splat64-0.32.2}/src/splat/scripts/split.py

@@ -271,11 +271,9 @@ def do_scan(
     for segment in scan_bar:
         assert isinstance(segment, Segment)
         scan_bar.set_description(f"Scanning {brief_seg_name(segment, 20)}")
-        typ = segment.type
-        if segment.type == "bin" and segment.is_name_default():
-            typ = "unk"
 
-        stats.add_size(typ, segment.size)
+        for ty, sub_stats in segment.statistics.items():
+            stats.add_size(ty, sub_stats.size)
 
         if segment.should_scan():
             # Check cache but don't write anything
@@ -287,7 +285,8 @@ def do_scan(
 
             processed_segments.append(segment)
 
-            stats.count_split(typ)
+            for ty, sub_stats in segment.statistics.items():
+                stats.count_split(ty, sub_stats.count)
 
     symbols.mark_c_funcs_as_defined()
     return processed_segments
@@ -305,7 +304,8 @@ def do_split(
         split_bar.set_description(f"Splitting {brief_seg_name(segment, 20)}")
 
         if cache.check_cache_hit(segment, True):
-            stats.count_cached(segment.type)
+            for ty, sub_stats in segment.statistics.items():
+                stats.count_cached(ty, sub_stats.count)
             continue
 
         if segment.should_split():

{splat64-0.32.0 → splat64-0.32.2}/src/splat/segtypes/common/bin.py

@@ -3,7 +3,7 @@ from typing import Optional
 
 from ...util import log, options
 
-from .segment import CommonSegment
+from .segment import CommonSegment, SegmentType
 
 
 class CommonSegBin(CommonSegment):
@@ -33,3 +33,10 @@ class CommonSegBin(CommonSegment):
 
             f.write(rom_bytes[self.rom_start : self.rom_end])
         self.log(f"Wrote {self.name} to {path}")
+
+    @property
+    def statistics_type(self) -> SegmentType:
+        stats_type = self.type
+        if self.is_name_default():
+            stats_type = "unk"
+        return stats_type

{splat64-0.32.0 → splat64-0.32.2}/src/splat/segtypes/common/codesubsegment.py

@@ -122,7 +122,7 @@ class CommonSegCodeSubsegment(Segment):
         )
 
         # Gather symbols found by spimdisasm and create those symbols in splat's side
-        for referenced_vram in func_spim.instrAnalyzer.referencedVrams:
+        for referenced_vram in func_spim.referencedVrams:
             context_sym = self.spim_section.get_section().getSymbol(
                 referenced_vram, tryPlusOffset=False
             )

{splat64-0.32.0 → splat64-0.32.2}/src/splat/segtypes/common/data.py

@@ -145,6 +145,16 @@ class CommonSegData(CommonSegCodeSubsegment, CommonSegGroup):
                 self.get_most_parent(), symbol.contextSym
             )
 
+            # Gather symbols found by spimdisasm and create those symbols in splat's side
+            for referenced_vram in symbol.referencedVrams:
+                context_sym = self.spim_section.get_section().getSymbol(
+                    referenced_vram, tryPlusOffset=False
+                )
+                if context_sym is not None:
+                    symbols.create_symbol_from_spim_symbol(
+                        self.get_most_parent(), context_sym
+                    )
+
             # Hint to the user that we are now in the .rodata section and no longer in the .data section (assuming rodata follows data)
             if (
                 self.suggestion_rodata_section_start

{splat64-0.32.0 → splat64-0.32.2}/src/splat/segtypes/common/group.py

@@ -3,7 +3,7 @@ from typing import List, Optional
 from ...util import log
 
 from .segment import CommonSegment
-from ..segment import Segment
+from ..segment import empty_statistics, Segment, SegmentStatistics
 
 
 class CommonSegGroup(CommonSegment):
@@ -124,6 +124,14 @@ class CommonSegGroup(CommonSegment):
                 return True
         return False
 
+    @property
+    def statistics(self) -> SegmentStatistics:
+        stats = empty_statistics()
+        for sub in self.subsegments:
+            for ty, info in sub.statistics.items():
+                stats[ty] = stats[ty].merge(info)
+        return stats
+
     def get_linker_entries(self):
         return [entry for sub in self.subsegments for entry in sub.get_linker_entries()]
 

{splat64-0.32.0 → splat64-0.32.2}/src/splat/segtypes/common/rodata.py

@@ -112,6 +112,16 @@ class CommonSegRodata(CommonSegData):
             )
             generated_symbol.linker_section = self.get_linker_section_linksection()
 
+            # Gather symbols found by spimdisasm and create those symbols in splat's side
+            for referenced_vram in symbol.referencedVrams:
+                context_sym = self.spim_section.get_section().getSymbol(
+                    referenced_vram, tryPlusOffset=False
+                )
+                if context_sym is not None:
+                    symbols.create_symbol_from_spim_symbol(
+                        self.get_most_parent(), context_sym
+                    )
+
             possible_text = self.get_possible_text_subsegment_for_symbol(symbol)
             if possible_text is not None:
                 text_segment, refenceeFunction = possible_text

splat64-0.32.2/src/splat/segtypes/common/segment.py

@@ -0,0 +1,5 @@
+from ...segtypes.segment import Segment, SegmentType
+
+
+class CommonSegment(Segment):
+    pass

{splat64-0.32.0 → splat64-0.32.2}/src/splat/segtypes/segment.py

@@ -1,3 +1,5 @@
+import collections
+import dataclasses
 import importlib
 import importlib.util
 from pathlib import Path
@@ -67,6 +69,27 @@ def parse_segment_section_order(segment: Union[dict, list]) -> List[str]:
     return default
 
 
+SegmentType = str
+
+
+@dataclasses.dataclass
+class SegmentStatisticsInfo:
+    size: int
+    count: int
+
+    def merge(self, other: "SegmentStatisticsInfo") -> "SegmentStatisticsInfo":
+        return SegmentStatisticsInfo(
+            size=self.size + other.size, count=self.count + other.count
+        )
+
+
+SegmentStatistics = dict[SegmentType, SegmentStatisticsInfo]
+
+
+def empty_statistics() -> SegmentStatistics:
+    return collections.defaultdict(lambda: SegmentStatisticsInfo(size=0, count=0))
+
+
 class Segment:
     require_unique_name = True
 
@@ -520,6 +543,17 @@ class Segment:
         else:
             return None
 
+    @property
+    def statistics(self) -> SegmentStatistics:
+        stats = empty_statistics()
+        if self.size is not None:
+            stats[self.statistics_type] = SegmentStatisticsInfo(size=self.size, count=1)
+        return stats
+
+    @property
+    def statistics_type(self) -> SegmentType:
+        return self.type
+
     @property
     def vram_end(self) -> Optional[int]:
         if self.vram_start is not None and self.size is not None:

{splat64-0.32.0 → splat64-0.32.2}/src/splat/util/statistics.py

@@ -24,15 +24,15 @@ class Statistics:
             self.seg_sizes[typ] = 0
         self.seg_sizes[typ] += 0 if size is None else size
 
-    def count_split(self, typ: str):
+    def count_split(self, typ: str, count: int = 1):
         if typ not in self.seg_split:
             self.seg_split[typ] = 0
-        self.seg_split[typ] += 1
+        self.seg_split[typ] += count
 
-    def count_cached(self, typ: str):
+    def count_cached(self, typ: str, count: int = 1):
         if typ not in self.seg_cached:
             self.seg_cached[typ] = 0
-        self.seg_cached[typ] += 1
+        self.seg_cached[typ] += count
 
     def print_statistics(self, total_size: int):
         unk_size = self.seg_sizes.get("unk", 0)

splat64-0.32.0/src/splat/segtypes/common/segment.py

@@ -1,5 +0,0 @@
-from ...segtypes.segment import Segment
-
-
-class CommonSegment(Segment):
-    pass