splat64 0.34.0__tar.gz → 0.34.2__tar.gz

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

@@ -1,14 +1,26 @@
 # splat Release Notes
 
+### 0.34.2
+
+* Emit an error if a top-level segment containing bss sections does not specify a `bss_size` value.
+* Emit an error if a bss section is outside the address space of its parent segment.
+
+### 0.34.1
+
+* Deprecate `--stdout-only` cli flag. Changed output such that errors and warnings go to stderr and all other output goes to stdout.
+
 ### 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.
+
+* Add new global option `is_unsupported_platform`. If enabled, disable checks on platform option.
+* Add 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
+
+* Fix `hasm` segments overwriting files already on disk.
 
 ### 0.33.0
 

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

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

{splat64-0.34.0 → splat64-0.34.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.34.0,<1.0.0
+splat64[mips]>=0.34.2,<1.0.0
 ```
 
 ### Optional dependencies

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

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

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

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

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

@@ -452,7 +452,8 @@ def main(
     make_full_disasm_for_code=False,
 ):
     if stdout_only:
-        progress_bar.out_file = sys.stdout
+        log.write("--stdout-only flag is deprecated", status="warn")
+    progress_bar.out_file = sys.stdout
 
     # Load config
     global config
@@ -538,7 +539,9 @@ def add_arguments_to_parser(parser: argparse.ArgumentParser):
         help="Skips the disassembler's version check",
     )
     parser.add_argument(
-        "--stdout-only", help="Print all output to stdout", action="store_true"
+        "--stdout-only",
+        help="Print all output to stdout (deprecated)",
+        action="store_true",
     )
     parser.add_argument(
         "--disassemble-all",

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

@@ -414,6 +414,26 @@ class Segment:
 
         ret.parent = parent
 
+        # Import here to avoid circular imports
+        from .common.code import CommonSegCode
+        from .common.bss import CommonSegBss
+
+        if options.opts.ld_bss_is_noload and isinstance(ret, CommonSegBss):
+            # We need to know the bss space for the segment.
+            if isinstance(parent, CommonSegCode):
+                if parent.bss_size <= 0:
+                    log.error(
+                        f"Top-level segment '{parent.name}' is missing a `bss_size` value.\n    A non-zero `bss_size` value must be defined on the top-level segments that contain '{ret.type}' sections (produced by the '{ret.name}' section)."
+                    )
+                if (
+                    isinstance(ret.vram_start, int)
+                    and isinstance(parent.vram_end, int)
+                    and ret.vram_start >= parent.vram_end
+                ):
+                    log.error(
+                        f"The section '{ret.name}' (vram 0x{ret.vram_start:08X}) is outside its parent's address range '{parent.name}' (0x{parent.vram_start:08X} ~ 0x{parent.vram_end:08X}).\n    This may happen when the specified `bss_size` value is too small."
+                    )
+
         ret.given_section_order = parse_segment_section_order(yaml)
         ret.given_subalign = parse_segment_subalign(yaml)
 

{splat64-0.34.0 → splat64-0.34.2}/src/splat/util/log.py

@@ -18,7 +18,12 @@ def write(*args, status=None, **kwargs):
         print("")
         newline = True
 
-    print(status_to_ansi(status) + str(args[0]), *args[1:], **kwargs)
+    print(
+        status_to_ansi(status) + str(args[0]),
+        *args[1:],
+        **kwargs,
+        file=output_file(status),
+    )
 
 
 def error(*args, **kwargs) -> NoReturn:
@@ -44,3 +49,9 @@ def status_to_ansi(status: Status):
         return Style.DIM
     else:
         return ""
+
+
+def output_file(status: Status):
+    if status == "warn" or status == "error":
+        return sys.stderr
+    return sys.stdout

{splat64-0.34.0 → splat64-0.34.2}/test.py

@@ -456,11 +456,11 @@ class InitializeSpimContext(unittest.TestCase):
 
         all_segments: List["Segment"] = [
             CommonSegCode(
-                rom_start=0x0,
-                rom_end=0x200,
+                rom_start=0x1000,
+                rom_end=0x1140,
                 type="code",
                 name="main",
-                vram_start=0x100,
+                vram_start=0x80000400,
                 args=[],
                 yaml=yaml,
             )
@@ -472,7 +472,7 @@ class InitializeSpimContext(unittest.TestCase):
         symbols.initialize_spim_context(all_segments)
         # spim should have added something to overlaySegments
         assert (
-            type(symbols.spim_context.overlaySegments["overlay"][0])
+            type(symbols.spim_context.overlaySegments["overlay"][0x1000])
             == spimdisasm.common.SymbolsSegment
         )
 
@@ -485,22 +485,21 @@ class InitializeSpimContext(unittest.TestCase):
             "name": "boot",
             "type": "code",
             "start": 0x1000,
-            "vram": 0x80000400,
+            "vram": 0x100,
             "bss_size": 0x80,
-            "exclusive_ram_id": "overlay",
             "subsegments": [
                 [0x1000, "c", "main"],
                 [0x10F0, "hasm", "handwritten"],
                 [0x1100, "data", "main"],
                 [0x1110, ".rodata", "main"],
-                {"start": 0x1140, "type": "bss", "vram": 0x80000540, "name": "main"},
+                {"start": 0x1140, "type": "bss", "vram": 0x240, "name": "main"},
             ],
         }
 
         all_segments: List["Segment"] = [
             CommonSegCode(
-                rom_start=0x0,
-                rom_end=0x200,
+                rom_start=0x1000,
+                rom_end=0x1140,
                 type="code",
                 name="main",
                 vram_start=0x100,
@@ -513,7 +512,7 @@ class InitializeSpimContext(unittest.TestCase):
         assert symbols.spim_context.globalSegment.vramEnd == 0x80001000
         symbols.initialize_spim_context(all_segments)
         assert symbols.spim_context.globalSegment.vramStart == 0x100
-        assert symbols.spim_context.globalSegment.vramEnd == 0x380
+        assert symbols.spim_context.globalSegment.vramEnd == 0x2C0
 
 
 if __name__ == "__main__":