splat64 0.33.2__tar.gz → 0.34.1__tar.gz

{splat64-0.33.2 → splat64-0.34.1}/CHANGELOG.md

@@ -1,5 +1,12 @@
 # splat Release Notes
 
+### 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
+* 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.
 

{splat64-0.33.2 → splat64-0.34.1}/PKG-INFO

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

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

{splat64-0.33.2 → splat64-0.34.1}/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
 
 

{splat64-0.33.2 → splat64-0.34.1}/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.2 → splat64-0.34.1}/pyproject.toml

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

{splat64-0.33.2 → splat64-0.34.1}/src/splat/__init__.py

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

{splat64-0.33.2 → splat64-0.34.1}/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
@@ -475,7 +476,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"])
@@ -537,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.33.2 → splat64-0.34.1}/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.2 → splat64-0.34.1}/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.33.2 → splat64-0.34.1}/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(