splat64 0.32.1__tar.gz → 0.32.3__tar.gz

{splat64-0.32.1 → splat64-0.32.3}/CHANGELOG.md

@@ -1,6 +1,17 @@
 # splat Release Notes
 
+### 0.32.3
+
+- Fix "unrecognized YAML option" error if disassemble_all is provided via CLI and as a YAML option.
+- Slightly speed up `bss` disassembly for projects over thousands of subsegments in the same top-level segment.
+
+### 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

{splat64-0.32.1 → splat64-0.32.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: splat64
-Version: 0.32.1
+Version: 0.32.3
 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.1,<1.0.0
+splat64[mips]>=0.32.3,<1.0.0
 ```
 
 ### Optional dependencies

{splat64-0.32.1 → splat64-0.32.3}/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.1,<1.0.0
+splat64[mips]>=0.32.3,<1.0.0
 ```
 
 ### Optional dependencies

{splat64-0.32.1 → splat64-0.32.3}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "splat64"
 # Should be synced with src/splat/__init__.py
-version = "0.32.1"
+version = "0.32.3"
 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",

{splat64-0.32.1 → splat64-0.32.3}/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.1 → splat64-0.32.3}/src/splat/__init__.py

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

{splat64-0.32.1 → splat64-0.32.3}/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.1 → splat64-0.32.3}/src/splat/segtypes/common/bss.py

@@ -60,7 +60,9 @@ class CommonSegBss(CommonSegData):
                 f"Segment '{self.name}' (type '{self.type}') requires a vram address. Got '{self.vram_start}'"
             )
 
-        next_subsegment = self.parent.get_next_subsegment_for_ram(self.vram_start)
+        next_subsegment = self.parent.get_next_subsegment_for_ram(
+            self.vram_start, self.index_within_group
+        )
         if next_subsegment is None:
             bss_end = self.get_most_parent().vram_end
         else:

{splat64-0.32.1 → splat64-0.32.3}/src/splat/segtypes/common/code.py

@@ -270,6 +270,8 @@ class CommonSegCode(CommonSegGroup):
                 sibling.siblings[segment.get_linker_section_linksection()] = segment
 
         ret = self._insert_all_auto_sections(ret, base_segments, readonly_before)
+        for i, seg in enumerate(ret):
+            seg.index_within_group = i
 
         return ret
 

{splat64-0.32.1 → splat64-0.32.3}/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.1 → splat64-0.32.3}/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.1 → splat64-0.32.3}/src/splat/segtypes/common/group.py

@@ -110,11 +110,16 @@ class CommonSegGroup(CommonSegment):
                 self.special_vram_segment = True
             segment.is_auto_segment = is_auto_segment
 
+            segment.index_within_group = len(ret)
+
             ret.append(segment)
             prev_start = start
             if end is not None:
                 last_rom_end = end
 
+        for i, seg in enumerate(ret):
+            seg.index_within_group = i
+
         return ret
 
     @property
@@ -165,13 +170,17 @@ class CommonSegGroup(CommonSegment):
                 return sub
         return None
 
-    def get_next_subsegment_for_ram(self, addr: int) -> Optional[Segment]:
+    def get_next_subsegment_for_ram(
+        self, addr: int, current_subseg_index: Optional[int]
+    ) -> Optional[Segment]:
         """
         Returns the first subsegment which comes after the specified address,
         or None in case this address belongs to the last subsegment of this group
         """
 
-        for sub in self.subsegments:
+        start = current_subseg_index if current_subseg_index is not None else 0
+
+        for sub in self.subsegments[start:]:
             if sub.vram_start is None:
                 continue
             assert isinstance(sub.vram_start, int)

{splat64-0.32.1 → splat64-0.32.3}/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.1 → splat64-0.32.3}/src/splat/segtypes/segment.py

@@ -255,7 +255,7 @@ class Segment:
 
     @staticmethod
     def parse_suggestion_rodata_section_start(
-        yaml: Union[dict, list]
+        yaml: Union[dict, list],
     ) -> Optional[bool]:
         if isinstance(yaml, dict):
             suggestion_rodata_section_start = yaml.get(
@@ -354,6 +354,8 @@ class Segment:
         # Is an automatic segment, generated automatically or declared on the yaml by the user
         self.is_auto_segment: bool = False
 
+        self.index_within_group: Optional[int] = None
+
         if self.rom_start is not None and self.rom_end is not None:
             if self.rom_start > self.rom_end:
                 log.error(

{splat64-0.32.1 → splat64-0.32.3}/src/splat/util/options.py

@@ -554,10 +554,10 @@ def _parse_yaml(
         detect_redundant_function_end=p.parse_opt(
             "detect_redundant_function_end", bool, True
         ),
-        # Command line argument takes precedence over yaml option
-        disassemble_all=(
-            disasm_all if disasm_all else p.parse_opt("disassemble_all", bool, False)
-        ),
+        # Setting either option will produce a full disassembly,
+        # but we still have to check the yaml option first to avoid leaving option unparsed,
+        # because splat would complain about an unrecognized yaml option otherwise.
+        disassemble_all=p.parse_opt("disassemble_all", bool, False) or disasm_all,
         global_vram_start=p.parse_optional_opt("global_vram_start", int),
         global_vram_end=p.parse_optional_opt("global_vram_end", int),
         use_gp_rel_macro_nonmatching=p.parse_opt(