splat64 0.33.1__tar.gz → 0.34.0__tar.gz

{splat64-0.33.1 → splat64-0.34.0}/CHANGELOG.md

@@ -1,5 +1,12 @@
 # splat Release Notes
 
+### 0.34.0
+* Added new global option `is_unsupported_platform`. If enabled, disable checks on platform option.
+* Added new global option `allow_segment_overrides`. If enabled, allows to take precedence over the splat builtin platform segments via splat extension.
+
+### 0.33.2
+* Change `make_full_disasm_for_code` to output other sections for the TU in addition to .text.
+
 ### 0.33.1
 * Fix `hasm` segments overwriting files already on disk
 

{splat64-0.33.1 → splat64-0.34.0}/PKG-INFO

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

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

{splat64-0.33.1 → splat64-0.34.0}/docs/Configuration.md

@@ -154,6 +154,21 @@ check_consecutive_segment_types: False
 ```
 
 
+### is_unsupported_platform
+
+Disable checks on `platform` option.
+
+Defaults to `False`.
+
+
+### allow_segment_overrides
+
+Allows to take precedence over the splat builtin platform segments via splat extension.
+
+Setting it to `True` tells splat to look for platorm segments in `extensions_path`.
+
+Defaults to `False`.
+
 ## Paths
 
 
@@ -729,7 +744,7 @@ Don't skip disassembling already matched functions and migrated sections
 
 ### make_full_disasm_for_code
 
-Emit a full `.s` file for each `c`/`cpp` segment besides the generated `nonmatchings` individual functions.
+Emit a full `.s` file for each `c`/`cpp` segment containing disassembly of .text and any available sibling sections, in addition to the normally-generated `nonmatchings` individual functions.
 
 Can be used to generate "target" or "expected" objects for asm diffing.
 

{splat64-0.33.1 → splat64-0.34.0}/docs/General-Workflow.md

@@ -124,6 +124,8 @@ For a GCC example, see the [include.h](https://github.com/AngheloAlf/drmario64/b
 
 For IDO, you will need to use [asm-processor](https://github.com/simonlindholm/asm-processor) in order to include assembly code within the c files.
 
+For MWCC, you will need [mwccgap](https://github.com/mkst/mwccgap) to include assembly code in the c files, similar to asm-processor.
+
 ## Assembly macros
 
 splat relies on some assembly macros for the asm generation. They usually live on the `include/macro.inc` file. Without these macros then an assembler would not be able to build our disassemblies.

{splat64-0.33.1 → splat64-0.34.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "splat64"
 # Should be synced with src/splat/__init__.py
-version = "0.33.1"
+version = "0.34.0"
 description = "A binary splitting tool to assist with decompilation and modding projects"
 readme = "README.md"
 license = {file = "LICENSE"}

{splat64-0.33.1 → splat64-0.34.0}/src/splat/__init__.py

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

{splat64-0.33.1 → splat64-0.34.0}/src/splat/scripts/split.py

@@ -475,7 +475,8 @@ def main(
 
     cache = cache_handler.Cache(config, use_cache, verbose)
 
-    initialize_platform(rom_bytes)
+    if not options.opts.is_unsupported_platform:
+        initialize_platform(rom_bytes)
 
     # Initialize segments
     all_segments = initialize_segments(config["segments"])

splat64-0.34.0/src/splat/segtypes/common/asmtu.py

@@ -0,0 +1,15 @@
+from .asm import CommonSegAsm
+
+
+class CommonSegAsmtu(CommonSegAsm):
+    def split(self, rom_bytes: bytes):
+        if self.rom_start == self.rom_end:
+            return
+
+        if self.spim_section is None:
+            return
+
+        out_path = self.out_path()
+        assert out_path is not None, str(self)
+
+        self.split_as_asmtu_file(out_path)

{splat64-0.33.1 → splat64-0.34.0}/src/splat/segtypes/common/c.py

@@ -250,7 +250,7 @@ class CommonSegC(CommonSegCodeSubsegment):
                         assert func_sym is not None
 
                         if (
-                            not entry.function.getName() in self.global_asm_funcs
+                            entry.function.getName() not in self.global_asm_funcs
                             and options.opts.disassemble_all
                             and not is_new_c_file
                         ):
@@ -281,7 +281,7 @@ class CommonSegC(CommonSegCodeSubsegment):
                 section = self.spim_section.get_section()
                 old_value = section.getGpRelHack()
                 section.setGpRelHack(False)
-                self.split_as_asm_file(self.asm_out_path())
+                self.split_as_asmtu_file(self.asm_out_path())
                 section.setGpRelHack(old_value)
 
     def get_c_preamble(self):
@@ -304,7 +304,7 @@ class CommonSegC(CommonSegCodeSubsegment):
 
             if rodata_sym.vramEnd != next_rodata_sym.vram:
                 log.write(
-                    f"\nA gap was detected in migrated rodata symbols!", status="warn"
+                    "\nA gap was detected in migrated rodata symbols!", status="warn"
                 )
                 log.write(
                     f"\t In function '{func.getName()}' (0x{func.vram:08X}), gap detected between '{rodata_sym.getName()}' (0x{rodata_sym.vram:08X}) and '{next_rodata_sym.getName()}' (0x{next_rodata_sym.vram:08X})"
@@ -313,7 +313,7 @@ class CommonSegC(CommonSegCodeSubsegment):
                     f"\t The address of the missing rodata symbol is 0x{rodata_sym.vramEnd:08X}"
                 )
                 log.write(
-                    f"\t Try to force the migration of that symbol with `force_migration:True` in the symbol_addrs.txt file; or avoid the migration of symbols around this address with `force_not_migration:True`"
+                    "\t Try to force the migration of that symbol with `force_migration:True` in the symbol_addrs.txt file; or avoid the migration of symbols around this address with `force_not_migration:True`"
                 )
 
     def create_c_asm_file(

{splat64-0.33.1 → splat64-0.34.0}/src/splat/segtypes/common/codesubsegment.py

@@ -238,12 +238,69 @@ class CommonSegCodeSubsegment(Segment):
         if self.spim_section is None:
             return
 
-        if out_path:
-            out_path.parent.mkdir(parents=True, exist_ok=True)
+        if not out_path:
+            return
+
+        out_path.parent.mkdir(parents=True, exist_ok=True)
+
+        self.print_file_boundaries()
+
+        with open(out_path, "w", newline="\n") as f:
+            # Write `.text` contents
+            for line in self.get_asm_file_header():
+                f.write(line + "\n")
+            f.write(self.spim_section.disassemble())
 
-            self.print_file_boundaries()
+    # Same as above but write all sections from siblings
+    def split_as_asmtu_file(self, out_path: Optional[Path]):
+        if self.spim_section is None:
+            return
+
+        if not out_path:
+            return
 
-            with open(out_path, "w", newline="\n") as f:
-                for line in self.get_asm_file_header():
-                    f.write(line + "\n")
-                f.write(self.spim_section.disassemble())
+        out_path.parent.mkdir(parents=True, exist_ok=True)
+
+        self.print_file_boundaries()
+
+        with open(out_path, "w", newline="\n") as f:
+            # Write `.text` contents
+            for line in self.get_asm_file_header():
+                f.write(line + "\n")
+            f.write(self.spim_section.disassemble())
+
+            # Disassemble the siblings to this file by respecting the `section_order`
+            for sect in self.section_order:
+                if sect == self.get_linker_section_linksection():
+                    continue
+
+                sibling = self.siblings.get(sect)
+                if sibling is None:
+                    continue
+
+                if (
+                    isinstance(sibling, CommonSegCodeSubsegment)
+                    and sibling.spim_section is not None
+                    and not sibling.should_self_split()
+                ):
+                    f.write("\n")
+                    f.write(f"{sibling.get_section_asm_line()}\n\n")
+                    f.write(sibling.spim_section.disassemble())
+
+            # Another loop to check anything that somehow may not be present on the `section_order`
+            for sect, sibling in self.siblings.items():
+                if sect == self.get_linker_section_linksection():
+                    continue
+
+                if sect in self.section_order:
+                    # Already handled on the above loop
+                    continue
+
+                if (
+                    isinstance(sibling, CommonSegCodeSubsegment)
+                    and sibling.spim_section is not None
+                    and not sibling.should_self_split()
+                ):
+                    f.write("\n")
+                    f.write(f"{sibling.get_section_asm_line()}\n\n")
+                    f.write(sibling.spim_section.disassemble())

{splat64-0.33.1 → splat64-0.34.0}/src/splat/segtypes/segment.py

@@ -99,10 +99,21 @@ class Segment:
         if seg_type.startswith("."):
             seg_type = seg_type[1:]
 
-        segment_class = Segment.get_base_segment_class(seg_type)
-        if segment_class == None:
-            # Look in extensions
+        if options.opts.allow_segment_overrides:
             segment_class = Segment.get_extension_segment_class(seg_type)
+            if segment_class == None:
+                segment_class = Segment.get_base_segment_class(seg_type)
+        else:
+            segment_class = Segment.get_base_segment_class(seg_type)
+            if segment_class == None:
+                # Look in extensions
+                segment_class = Segment.get_extension_segment_class(seg_type)
+
+        if segment_class == None:
+            log.error(
+                f"could not load segment type '{seg_type}'\n(hint: confirm your extension directory is configured correctly)"
+            )
+
         return segment_class
 
     @staticmethod
@@ -147,11 +158,8 @@ class Segment:
             ext_mod = importlib.util.module_from_spec(ext_spec)
             assert ext_spec.loader is not None
             ext_spec.loader.exec_module(ext_mod)
-        except Exception as err:
-            log.write(err, status="error")
-            log.error(
-                f"could not load segment type '{seg_type}'\n(hint: confirm your extension directory is configured correctly)"
-            )
+        except Exception:
+            return None
 
         return getattr(
             ext_mod, f"{platform.upper()}Seg{seg_type[0].upper()}{seg_type[1:]}"

{splat64-0.33.1 → splat64-0.34.0}/src/splat/util/options.py

@@ -41,6 +41,10 @@ class SplatOpts:
     gp: Optional[int]
     # Checks and errors if there are any non consecutive segment types
     check_consecutive_segment_types: bool
+    # Disable checks on `platform` option.
+    is_unsupported_platform: bool
+    # Allows to take precedence over the splat builtin platform segments via splat extension.
+    allow_segment_overrides: bool
 
     # Paths
     asset_path: Path
@@ -355,7 +359,13 @@ def _parse_yaml(
     p = OptParser(yaml)
 
     basename = p.parse_opt("basename", str)
-    platform = p.parse_opt_within("platform", str, ["n64", "psx", "ps2", "psp"])
+    is_unsupported_platform = p.parse_opt("is_unsupported_platform", bool, False)
+
+    if is_unsupported_platform:
+        platform = p.parse_opt("platform", str)
+    else:
+        platform = p.parse_opt_within("platform", str, ["n64", "psx", "ps2", "psp"])
+
     comp = compiler.for_name(p.parse_opt("compiler", str, "IDO"))
 
     base_path = Path(
@@ -399,6 +409,8 @@ def _parse_yaml(
         target_path=p.parse_path(base_path, "target_path"),
         elf_path=p.parse_optional_path(base_path, "elf_path"),
         platform=platform,
+        is_unsupported_platform=is_unsupported_platform,
+        allow_segment_overrides=p.parse_opt("allow_segment_overrides", bool, False),
         compiler=comp,
         endianness=parse_endianness(),
         section_order=p.parse_opt(

splat64-0.33.1/src/splat/segtypes/common/asmtu.py

@@ -1,65 +0,0 @@
-from pathlib import Path
-from typing import Optional, TextIO
-
-from ...util import log, options
-
-from .asm import CommonSegAsm
-from .codesubsegment import CommonSegCodeSubsegment
-
-
-class CommonSegAsmtu(CommonSegAsm):
-    def split(self, rom_bytes: bytes):
-        if self.rom_start == self.rom_end:
-            return
-
-        if self.spim_section is None:
-            return
-
-        out_path = self.out_path()
-        assert out_path is not None, str(self)
-
-        out_path.parent.mkdir(parents=True, exist_ok=True)
-
-        self.print_file_boundaries()
-
-        with open(out_path, "w", newline="\n") as f:
-            # Write `.text` contents
-            for line in self.get_asm_file_header():
-                f.write(line + "\n")
-            f.write(self.spim_section.disassemble())
-
-            # Disassemble the siblings to this file by respecting the `section_order`
-            for sect in self.section_order:
-                if sect == self.get_linker_section_linksection():
-                    continue
-
-                sibling = self.siblings.get(sect)
-                if sibling is None:
-                    continue
-
-                if (
-                    isinstance(sibling, CommonSegCodeSubsegment)
-                    and sibling.spim_section is not None
-                    and not sibling.should_self_split()
-                ):
-                    f.write("\n")
-                    f.write(f"{sibling.get_section_asm_line()}\n\n")
-                    f.write(sibling.spim_section.disassemble())
-
-            # Another loop to check anything that somehow may not be present on the `section_order`
-            for sect, sibling in self.siblings.items():
-                if sect == self.get_linker_section_linksection():
-                    continue
-
-                if sect in self.section_order:
-                    # Already handled on the above loop
-                    continue
-
-                if (
-                    isinstance(sibling, CommonSegCodeSubsegment)
-                    and sibling.spim_section is not None
-                    and not sibling.should_self_split()
-                ):
-                    f.write("\n")
-                    f.write(f"{sibling.get_section_asm_line()}\n\n")
-                    f.write(sibling.spim_section.disassemble())