splat64 0.35.2__py3-none-any.whl → 0.36.1__py3-none-any.whl

splat/__init__.py

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

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, 36, 0)
+    SPIMDISASM_MIN = (1, 36, 1)
 
     def configure(self):
         # Configure spimdisasm

splat/scripts/create_config.py

@@ -286,6 +286,7 @@ options:
 
   find_file_boundaries: False
   gp_value: 0x{exe.initial_gp:08X}
+  # ld_gp_expression: main_SCOMMON_START + 0x7FF0
 
   o_as_suffix: True
   use_legacy_include_asm: False
@@ -309,6 +310,10 @@ options:
   data_string_encoding: ASCII
   rodata_string_guesser_level: 2
   data_string_guesser_level: 2
+
+  # Uncomment this line if you need to use the maspsx reorder workaround hack
+  # https://github.com/mkst/maspsx?tab=readme-ov-file#include_asm-reordering-workaround-hack
+  # include_asm_macro_style: maspsx_hack
 """
 
     segments = f"""\

splat/segtypes/common/textbin.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+import re
 from typing import Optional, TextIO
 
 from ...util import log, options
@@ -75,45 +76,66 @@ class CommonSegTextbin(CommonSegment):
 
         f.write(f"{self.get_section_asm_line()}\n\n")
 
+        sym_name = None
+        sym_name_end = None
+        sym_size_matches = None
+
         # Check if there's a symbol at this address
-        sym = None
         vram = self.rom_to_ram(self.rom_start)
         if vram is not None:
             sym = self.get_symbol(vram, in_segment=True)
-
-        if sym is not None:
-            f.write(f"{asm_label} {sym.name}\n")
-            if asm_label == ".globl":
-                if self.is_text():
-                    f.write(f".ent {sym.name}\n")
-                f.write(f"{sym.name}:\n")
-            sym.defined = True
+            if sym is not None:
+                sym.defined = True
+                sym_name = sym.name
+                sym_name_end = sym.given_name_end
+                if (
+                    sym.given_size is None
+                    or sym.given_size == self.rom_end - self.rom_start
+                ):
+                    sym_size_matches = self.rom_end - self.rom_start
+
+        if sym_name is None:
+            # Normalize stuff like slashes and such.
+            n = regex_sym_name_normalizer.sub("_", self.name)
+            if self.is_text():
+                suffix = "textbin"
+            elif self.is_data():
+                suffix = "databin"
+            elif self.is_rodata():
+                suffix = "rodatabin"
+            else:
+                suffix = "incbin"
+            sym_name = f"__{n}_{suffix}"
+
+        if options.opts.asm_nonmatching_label_macro != "":
+            siz = f", 0x{sym_size_matches:X}" if sym_size_matches is not None else ""
+            f.write(f"{options.opts.asm_nonmatching_label_macro} {sym_name}{siz}\n\n")
+
+        f.write(f"{asm_label} {sym_name}\n")
+        if asm_label == ".globl":
+            if self.is_text():
+                f.write(f".ent {sym_name}\n")
+            f.write(f"{sym_name}:\n")
 
         f.write(f'.incbin "{binpath.as_posix()}"\n')
 
-        if sym is not None:
-            if options.opts.asm_emit_size_directive:
-                f.write(f".size {sym.name}, . - {sym.name}\n")
+        if options.opts.asm_emit_size_directive:
+            f.write(f".size {sym_name}, . - {sym_name}\n")
 
-            if self.is_text() and options.opts.asm_end_label != "":
-                f.write(f"{options.opts.asm_end_label} {sym.name}\n")
-            elif self.is_data() and options.opts.asm_data_end_label != "":
-                f.write(f"{options.opts.asm_data_end_label} {sym.name}\n")
+        if self.is_text() and options.opts.asm_end_label != "":
+            f.write(f"{options.opts.asm_end_label} {sym_name}\n")
+        elif options.opts.asm_data_end_label != "":
+            f.write(f"{options.opts.asm_data_end_label} {sym_name}\n")
 
-            if sym.given_name_end is not None:
-                if (
-                    sym.given_size is None
-                    or sym.given_size == self.rom_end - self.rom_start
-                ):
-                    f.write(f"{asm_label} {sym.given_name_end}\n")
-                    if asm_label == ".globl":
-                        f.write(f"{sym.given_name_end}:\n")
-                    if self.is_text() and options.opts.asm_end_label != "":
-                        f.write(f"{options.opts.asm_end_label} {sym.given_name_end}\n")
-                    elif self.is_data() and options.opts.asm_data_end_label != "":
-                        f.write(
-                            f"{options.opts.asm_data_end_label} {sym.given_name_end}\n"
-                        )
+        if sym_name_end is not None and sym_size_matches is not None:
+            f.write(f"{asm_label} {sym_name_end}\n")
+            if asm_label == ".globl":
+                f.write(f"{sym_name_end}:\n")
+
+            if self.is_text() and options.opts.asm_end_label != "":
+                f.write(f"{options.opts.asm_end_label} {sym_name_end}\n")
+            elif options.opts.asm_data_end_label != "":
+                f.write(f"{options.opts.asm_data_end_label} {sym_name_end}\n")
 
     def split(self, rom_bytes):
         if self.rom_end is None:
@@ -159,3 +181,6 @@ class CommonSegTextbin(CommonSegment):
         return (
             self.extract and self.should_scan()
         )  # only split if the segment was scanned first
+
+
+regex_sym_name_normalizer = re.compile(r"[^0-9a-zA-Z_]")

splat/segtypes/linker_entry.py

@@ -204,8 +204,10 @@ class LinkerWriter:
         if not self.is_partial:
             self._writeln(f"__romPos = {options.opts.ld_rom_start};")
 
-            if options.opts.gp is not None:
-                self._writeln("_gp = " + f"0x{options.opts.gp:X};")
+            if options.opts.ld_gp_expression is not None:
+                self._writeln(f"_gp = {options.opts.ld_gp_expression};")
+            elif options.opts.gp is not None:
+                self._writeln(f"_gp = 0x{options.opts.gp:X};")
 
     # Write a series of statements which compute a symbol that represents the highest address among a list of segments' end addresses
     def write_max_vram_end_sym(self, symbol: str, overlays: List[Segment]):

splat/segtypes/n64/i1.py

@@ -1,9 +1,9 @@
-import n64img.image
-
-from .img import N64SegImg
-
-
-class N64SegI1(N64SegImg):
-    def __init__(self, *args, **kwargs):
-        kwargs["img_cls"] = n64img.image.I1
-        super().__init__(*args, **kwargs)
+import n64img.image
+
+from .img import N64SegImg
+
+
+class N64SegI1(N64SegImg):
+    def __init__(self, *args, **kwargs):
+        kwargs["img_cls"] = n64img.image.I1
+        super().__init__(*args, **kwargs)

splat/util/file_presets.py

@@ -24,6 +24,12 @@ def write_all_files():
 def _write(filepath: str, contents: str):
     p = Path(os.path.normpath(options.opts.base_path / filepath))
     p.parent.mkdir(parents=True, exist_ok=True)
+
+    if p.exists():
+        with p.open("r", encoding="UTF-8") as f:
+            existing_contents = f.read()
+        if existing_contents == contents:
+            return
     with p.open("w", encoding="UTF-8", newline="\n") as f:
         f.write(contents)
 
@@ -33,13 +39,23 @@ def write_include_asm_h():
         # These compilers do not use the `INCLUDE_ASM` macro.
         return
 
-    file_data = """\
-#ifndef INCLUDE_ASM_H
-#define INCLUDE_ASM_H
-
-#if !defined(M2CTX) && !defined(PERMUTER)
-
-#ifndef INCLUDE_ASM
+    if options.opts.include_asm_macro_style == "maspsx_hack":
+        include_asm_macro = """\
+#define INCLUDE_ASM(FOLDER, NAME) \\
+    void __maspsx_include_asm_hack_##NAME() { \\
+        __asm__( \\
+            ".text # maspsx-keep \\n" \\
+            "    .align 2 # maspsx-keep\\n" \\
+            "    .set noat # maspsx-keep\\n" \\
+            "    .set noreorder # maspsx-keep\\n" \\
+            "    .include \\"" FOLDER "/" #NAME ".s\\" # maspsx-keep\\n" \\
+            "    .set reorder # maspsx-keep\\n" \\
+            "    .set at # maspsx-keep\\n" \\
+        ); \\
+    }
+"""
+    else:  # default
+        include_asm_macro = """\
 #define INCLUDE_ASM(FOLDER, NAME) \\
     __asm__( \\
         ".section .text\\n" \\
@@ -49,14 +65,28 @@ def write_include_asm_h():
         "    .set reorder\\n" \\
         "    .set at\\n" \\
     )
-#endif
-#ifndef INCLUDE_RODATA
+"""
+
+    include_rodata_macro = """\
 #define INCLUDE_RODATA(FOLDER, NAME) \\
     __asm__( \\
         ".section .rodata\\n" \\
         "    .include \\"" FOLDER "/" #NAME ".s\\"\\n" \\
         ".section .text" \\
     )
+"""
+
+    file_data = f"""\
+#ifndef INCLUDE_ASM_H
+#define INCLUDE_ASM_H
+
+#if !defined(M2CTX) && !defined(PERMUTER)
+
+#ifndef INCLUDE_ASM
+{include_asm_macro}\
+#endif
+#ifndef INCLUDE_RODATA
+{include_rodata_macro}\
 #endif
 __asm__(".include \\"include/labels.inc\\"\\n");
 
@@ -315,92 +345,99 @@ def write_gte_macros():
     # Taken directly from https://github.com/Decompollaborate/rabbitizer/blob/develop/docs/r3000gte/gte_macros.s
     # Please try to upstream any fix/update done here.
     gte_macros = """
-## GTE instructions macros
-## This macros are meant to be used with GAS and avoid using DMPSX
+.ifndef .L_GTE_MACRO_INC
+.L_GTE_MACRO_INC:
+
+## GTE instruction macros
+## These are meant for use with GAS and replace DMPSX
+
+.macro cop2op pseudo, op, sf = 1, mx = 0, v = 0, cv = 0, lm = 0
+    cop2 \\pseudo << 20 | \\sf << 19 | \\mx << 17 | \\v << 15 | \\cv << 13 | \\lm << 10 | \\op
+.endm
 
 /*  RTPS    15      0x4A180001  Perspective transform */
 .macro rtps
-    .word 0x4A180001
+    cop2op 0x01, 0x01
 .endm
 
 /*  RTPT    23      0x4A280030  Perspective transform on 3 points */
 .macro rtpt
-    .word 0x4A280030
+    cop2op 0x02, 0x30
 .endm
 
 /*  DPCL    8       0x4A680029  Depth Cue Color light */
 .macro dpcl
-    .word 0x4A680029
+    cop2op 0x06, 0x29
 .endm
 
 /*  DPCS    8       0x4A780010  Depth Cueing */
 .macro dpcs
-    .word 0x4A780010
+    cop2op 0x07, 0x10
 .endm
 
-/*  DPCT    17      0x4AF8002A  Depth cue color RGB0,RGB1,RGB2 */
+/*  DPCT    17      0x4A88002A  Depth cue color RGB0,RGB1,RGB2 */
 .macro dpct
-    .word 0x4AF8002A
+    cop2op 0x08, 0x2A
 .endm
 
 /*  INTPL   8       0x4A980011  Interpolation of vector and far color */
 .macro intpl
-    .word 0x4A980011
+    cop2op 0x09, 0x11
 .endm
 
 /*  NCS     14      0x4AC8041E  Normal color v0 */
 .macro ncs
-    .word 0x4AC8041E
+    cop2op 0x0C, 0x1E, lm = 1
 .endm
 
 /*  NCT     30      0x4AD80420  Normal color v0, v1, v2 */
 .macro nct
-    .word 0x4AD80420
+    cop2op 0x0D, 0x20, lm = 1
 .endm
 
 /*  NCDS    19      0x4AE80413  Normal color depth cuev0 */
 .macro ncds
-    .word 0x4AE80413
+    cop2op 0x0E, 0x13, lm = 1
 .endm
 
 /*  NCDT    44      0x4AF80416  Normal color depth cue v0, v1, v2 */
 .macro ncdt
-    .word 0x4AF80416
+    cop2op 0x0F, 0x16, lm = 1
 .endm
 
 /*  NCCS    17      0x4B08041B  Normal color col. v0 */
 .macro nccs
-    .word 0x4B08041B
+    cop2op 0x10, 0x1B, lm = 1
 .endm
 
 /*  NCCT    39      0x4B18043F  Normal color col.v0, v1, v2 */
 .macro ncct
-    .word 0x4B18043F
+    cop2op 0x11, 0x3F, lm = 1
 .endm
 
 /*  CDP     13      0x4B280414  Color Depth Queue */
 .macro cdp
-    .word 0x4B280414
+    cop2op 0x12, 0x14, lm = 1
 .endm
 
 /*  CC      11      0x4B38041C  Color Col. */
 .macro cc
-    .word 0x4B38041C
+    cop2op 0x13, 0x1C, lm = 1
 .endm
 
 /*  NCLIP   8       0x4B400006  Normal clipping */
 .macro nclip
-    .word 0x4B400006
+    cop2op 0x14, 0x06, sf = 0
 .endm
 
 /*  AVSZ3   5       0x4B58002D  Average of three Z values */
 .macro avsz3
-    .word 0x4B58002D
+    cop2op 0x15, 0x2D
 .endm
 
 /*  AVSZ4   6       0x4B68002E  Average of four Z values */
 .macro avsz4
-    .word 0x4B68002E
+    cop2op 0x16, 0x2E
 .endm
 
 
@@ -411,29 +448,29 @@ def write_gte_macros():
 # cv : arg is 2 bit wide
 # lm : arg is 1 bit wide
 
-/*  MVMVA   8       0x4A400012  Multiply vector by matrix and vector addition. */
+/*  mvmva   8       0x4A4nnn12  Multiply vector by matrix and vector addition. */
 .macro mvmva sf, mx, v, cv, lm
-    .word 0x4A400012 | (\\sf & 0x1) << 19 | (\\mx & 0x3) << 17 | (\\v & 0x3) << 15 | (\\cv & 0x3) << 13 | (\\lm & 0x1) << 10
+    cop2op 0x04, 0x12, sf = \\sf, mx = \\mx, v = \\v, cv = \\cv, lm = \\lm
 .endm
 
-/*  SQR     5       0x4AA00428  Square of vector */
+/*  SQR     5       0x4AAn0428  Square of vector */
 .macro sqr sf
-    .word 0x4AA00428 | (\\sf & 0x1) << 19
+    cop2op 0x0A, 0x28, sf = \\sf, lm = 1
 .endm
 
-/*  OP      6       0x4B70000C  Outer Product */
+/*  OP      6       0x4B7n000C  Outer Product */
 .macro op sf
-    .word 0x4B70000C | (\\sf & 0x1) << 19
+    cop2op 0x17, 0x0C, sf = \\sf
 .endm
 
-/*  GPF     6       0x4B90003D  General purpose interpolation */
+/*  GPF     6       0x4B9n003D  General purpose interpolation */
 .macro gpf sf
-    .word 0x4B90003D | (\\sf & 0x1) << 19
+    cop2op 0x19, 0x3D, sf = \\sf
 .endm
 
-/*  GPL     5       0x4BA0003E  general purpose interpolation */
+/*  GPL     5       0x4BAn003E  general purpose interpolation */
 .macro gpl sf
-    .word 0x4BA0003E | (\\sf & 0x1) << 19
+    cop2op 0x1A, 0x3E, sf = \\sf
 .endm
 
 
@@ -442,284 +479,286 @@ def write_gte_macros():
 /*  rtv0    -       0x4A486012  v0 * rotmatrix */
 .macro rtv0
     # .word 0x4A486012
-    MVMVA       1, 0, 0, 3, 0
+    mvmva       1, 0, 0, 3, 0
 .endm
 
 /*  rtv1    -       0x4A48E012  v1 * rotmatrix */
 .macro rtv1
     # .word 0x4A48E012
-    MVMVA       1, 0, 1, 3, 0
+    mvmva       1, 0, 1, 3, 0
 .endm
 
 /*  rtv2    -       0x4A496012  v2 * rotmatrix */
 .macro rtv2
     # .word 0x4A496012
-    MVMVA       1, 0, 2, 3, 0
+    mvmva       1, 0, 2, 3, 0
 .endm
 
 /*  rtir12  -       0x4A49E012  ir * rotmatrix */
 .macro rtir12
     # .word 0x4A49E012
-    MVMVA       1, 0, 3, 3, 0
+    mvmva       1, 0, 3, 3, 0
 .endm
 
 /*  rtir0   -       0x4A41E012  ir * rotmatrix */
 .macro rtir0
     # .word 0x4A41E012
-    MVMVA       0, 0, 3, 3, 0
+    mvmva       0, 0, 3, 3, 0
 .endm
 
 /*  rtv0tr  -       0x4A480012  v0 * rotmatrix + tr vector */
 .macro rtv0tr
     # .word 0x4A480012
-    MVMVA       1, 0, 0, 0, 0
+    mvmva       1, 0, 0, 0, 0
 .endm
 
 /*  rtv1tr  -       0x4A488012  v1 * rotmatrix + tr vector */
 .macro rtv1tr
     # .word 0x4A488012
-    MVMVA       1, 0, 1, 0, 0
+    mvmva       1, 0, 1, 0, 0
 .endm
 
 /*  rtv2tr  -       0x4A490012  v2 * rotmatrix + tr vector */
 .macro rtv2tr
     # .word 0x4A490012
-    MVMVA       1, 0, 2, 0, 0
+    mvmva       1, 0, 2, 0, 0
 .endm
 
 /*  rtirtr  -       0x4A498012  ir * rotmatrix + tr vector */
 .macro rtirtr
     # .word 0x4A498012
-    MVMVA       1, 0, 3, 0, 0
+    mvmva       1, 0, 3, 0, 0
 .endm
 
 /*  rtv0bk  -       0x4A482012  v0 * rotmatrix + bk vector */
 .macro rtv0bk
     # .word 0x4A482012
-    MVMVA       1, 0, 0, 1, 0
+    mvmva       1, 0, 0, 1, 0
 .endm
 
 /*  rtv1bk  -       0x4A48A012  v1 * rotmatrix + bk vector */
 .macro rtv1bk
     # .word 0x4A48A012
-    MVMVA       1, 0, 1, 1, 0
+    mvmva       1, 0, 1, 1, 0
 .endm
 
 /*  rtv2bk  -       0x4A492012  v2 * rotmatrix + bk vector */
 .macro rtv2bk
     # .word 0x4A492012
-    MVMVA       1, 0, 2, 1, 0
+    mvmva       1, 0, 2, 1, 0
 .endm
 
 /*  rtirbk  -       0x4A49A012  ir * rotmatrix + bk vector */
 .macro rtirbk
     # .word 0x4A49A012
-    MVMVA       1, 0, 3, 1, 0
+    mvmva       1, 0, 3, 1, 0
 .endm
 
 /*  ll      -       0x4A4A6412  v0 * light matrix. Lower limit result to 0 */
 .macro ll
     # .word 0x4A4A6412
-    MVMVA       1, 1, 0, 3, 1
+    mvmva       1, 1, 0, 3, 1
 .endm
 
 /*  llv0    -       0x4A4A6012  v0 * light matrix */
 .macro llv0
     # .word 0x4A4A6012
-    MVMVA       1, 1, 0, 3, 0
+    mvmva       1, 1, 0, 3, 0
 .endm
 
 /*  llv1    -       0x4A4AE012  v1 * light matrix */
 .macro llv1
     # .word 0x4A4AE012
-    MVMVA       1, 1, 1, 3, 0
+    mvmva       1, 1, 1, 3, 0
 .endm
 
 /*  llv2    -       0x4A4B6012  v2 * light matrix */
 .macro llv2
     # .word 0x4A4B6012
-    MVMVA       1, 1, 2, 3, 0
+    mvmva       1, 1, 2, 3, 0
 .endm
 
 /*  llvir   -       0x4A4BE012  ir * light matrix */
 .macro llvir
     # .word 0x4A4BE012
-    MVMVA       1, 1, 3, 3, 0
+    mvmva       1, 1, 3, 3, 0
 .endm
 
 /*  llv0tr  -       0x4A4A0012  v0 * light matrix + tr vector */
 .macro llv0tr
     # .word 0x4A4A0012
-    MVMVA       1, 1, 0, 0, 0
+    mvmva       1, 1, 0, 0, 0
 .endm
 
 /*  llv1tr  -       0x4A4A8012  v1 * light matrix + tr vector */
 .macro llv1tr
     # .word 0x4A4A8012
-    MVMVA       1, 1, 1, 0, 0
+    mvmva       1, 1, 1, 0, 0
 .endm
 
 /*  llv2tr  -       0x4A4B0012  v2 * light matrix + tr vector */
 .macro llv2tr
     # .word 0x4A4B0012
-    MVMVA       1, 1, 2, 0, 0
+    mvmva       1, 1, 2, 0, 0
 .endm
 
 /*  llirtr  -       0x4A4B8012  ir * light matrix + tr vector */
 .macro llirtr
     # .word 0x4A4B8012
-    MVMVA       1, 1, 3, 0, 0
+    mvmva       1, 1, 3, 0, 0
 .endm
 
 /*  llv0bk  -       0x4A4A2012  v0 * light matrix + bk vector */
 .macro llv0bk
     # .word 0x4A4A2012
-    MVMVA       1, 1, 0, 1, 0
+    mvmva       1, 1, 0, 1, 0
 .endm
 
 /*  llv1bk  -       0x4A4AA012  v1 * light matrix + bk vector */
 .macro llv1bk
     # .word 0x4A4AA012
-    MVMVA       1, 1, 1, 1, 0
+    mvmva       1, 1, 1, 1, 0
 .endm
 
 /*  llv2bk  -       0x4A4B2012  v2 * light matrix + bk vector */
 .macro llv2bk
     # .word 0x4A4B2012
-    MVMVA       1, 1, 2, 1, 0
+    mvmva       1, 1, 2, 1, 0
 .endm
 
 /*  llirbk  -       0x4A4BA012  ir * light matrix + bk vector */
 .macro llirbk
     # .word 0x4A4BA012
-    MVMVA       1, 1, 3, 1, 0
+    mvmva       1, 1, 3, 1, 0
 .endm
 
 /*  lc      -       0x4A4DA412  v0 * color matrix, Lower limit clamped to 0 */
 .macro lc
     # .word 0x4A4DA412
-    MVMVA       1, 2, 3, 1, 1
+    mvmva       1, 2, 3, 1, 1
 .endm
 
 /*  lcv0    -       0x4A4C6012  v0 * color matrix */
 .macro lcv0
     # .word 0x4A4C6012
-    MVMVA       1, 2, 0, 3, 0
+    mvmva       1, 2, 0, 3, 0
 .endm
 
 /*  lcv1    -       0x4A4CE012  v1 * color matrix */
 .macro lcv1
     # .word 0x4A4CE012
-    MVMVA       1, 2, 1, 3, 0
+    mvmva       1, 2, 1, 3, 0
 .endm
 
 /*  lcv2    -       0x4A4D6012  v2 * color matrix */
 .macro lcv2
     # .word 0x4A4D6012
-    MVMVA       1, 2, 2, 3, 0
+    mvmva       1, 2, 2, 3, 0
 .endm
 
 /*  lcvir   -       0x4A4DE012  ir * color matrix */
 .macro lcvir
     # .word 0x4A4DE012
-    MVMVA       1, 2, 3, 3, 0
+    mvmva       1, 2, 3, 3, 0
 .endm
 
 /*  lcv0tr  -       0x4A4C0012  v0 * color matrix + tr vector */
 .macro lcv0tr
     # .word 0x4A4C0012
-    MVMVA       1, 2, 0, 0, 0
+    mvmva       1, 2, 0, 0, 0
 .endm
 
 /*  lcv1tr  -       0x4A4C8012  v1 * color matrix + tr vector */
 .macro lcv1tr
     # .word 0x4A4C8012
-    MVMVA       1, 2, 1, 0, 0
+    mvmva       1, 2, 1, 0, 0
 .endm
 
 /*  lcv2tr  -       0x4A4D0012  v2 * color matrix + tr vector */
 .macro lcv2tr
     # .word 0x4A4D0012
-    MVMVA       1, 2, 2, 0, 0
+    mvmva       1, 2, 2, 0, 0
 .endm
 
 /*  lcirtr  -       0x4A4D8012  ir * color matrix + tr vector */
 .macro lcirtr
     # .word 0x4A4D8012
-    MVMVA       1, 2, 3, 0, 0
+    mvmva       1, 2, 3, 0, 0
 .endm
 
 /*  lev0bk  -       0x4A4C2012  v0 * color matrix + bk vector */
 .macro lev0bk
     # .word 0x4A4C2012
-    MVMVA       1, 2, 0, 1, 0
+    mvmva       1, 2, 0, 1, 0
 .endm
 
 /*  lev1bk  -       0x4A4CA012  v1 * color matrix + bk vector */
 .macro lev1bk
     # .word 0x4A4CA012
-    MVMVA       1, 2, 1, 1, 0
+    mvmva       1, 2, 1, 1, 0
 .endm
 
 /*  lev2bk  -       0x4A4D2012  v2 * color matrix + bk vector */
 .macro lev2bk
     # .word 0x4A4D2012
-    MVMVA       1, 2, 2, 1, 0
+    mvmva       1, 2, 2, 1, 0
 .endm
 
 /*  leirbk  -       0x4A4DA012  ir * color matrix + bk vector */
 .macro leirbk
     # .word 0x4A4DA012
-    MVMVA       1, 2, 3, 1, 0
+    mvmva       1, 2, 3, 1, 0
 .endm
 
 /*  sqr12   -       0x4AA80428  square of ir    1,19,12 */
 # .macro sqr12
 #     # .word 0x4AA80428
-#     SQR         1
+#     sqr         1
 # .endm
 
-/*  sqr0    -       0x4AA80428  square of ir    1,31, 0 */
+/*  sqr0    -       0x4AA00428  square of ir    1,31, 0 */
 # .macro sqr0
-#     # .word 0x4AA80428
-#     SQR         1
+#     # .word 0x4AA00428
+#     sqr         0
 # .endm
 
 /*  op12    -       0x4B78000C  outer product   1,19,12 */
 .macro op12
     # .word 0x4B78000C
-    OP          1
+    op          1
 .endm
 
 /*  op0     -       0x4B70000C  outer product   1,31, 0 */
 .macro op0
     # .word 0x4B70000C
-    OP          0
+    op          0
 .endm
 
 /*  gpf12   -       0x4B98003D  general purpose interpolation   1,19,12 */
 .macro gpf12
     # .word 0x4B98003D
-    GPF         1
+    gpf         1
 .endm
 
 /*  gpf0    -       0x4B90003D  general purpose interpolation   1,31, 0 */
 .macro gpf0
     # .word 0x4B90003D
-    GPF         0
+    gpf         0
 .endm
 
 /*  gpl12   -       0x4BA8003E  general purpose interpolation   1,19,12 */
 .macro gpl12
     # .word 0x4BA8003E
-    GPL         1
+    gpl         1
 .endm
 
 /*  gpl0    -       0x4BA0003E  general purpose interpolation   1,31, 0 */
 .macro gpl0
     # .word 0x4BA0003E
-    GPL         0
+    gpl         0
 .endm
+
+.endif
 """
 
     _write("include/gte_macros.inc", gte_macros)

splat/util/options.py

@@ -37,7 +37,12 @@ class SplatOpts:
     generated_s_preamble: str
     # Determines any extra content to be added in the generated macro.inc file
     generated_macro_inc_content: Optional[str]
+    # Determines if files related to assembly macros should be regenerated by splat
     generate_asm_macros_files: bool
+    # Changes the definition of the generated `INCLUDE_ASM`.
+    # default: The default one.
+    # maspsx_hack: Use the maspsx hack workaround definition https://github.com/mkst/maspsx?tab=readme-ov-file#include_asm-reordering-workaround-hack
+    include_asm_macro_style: Literal["default", "maspsx_hack"]
     # Determines whether to use .o as the suffix for all binary files?... TODO document
     use_o_as_suffix: bool
     # the value of the $gp register to correctly calculate offset to %gp_rel relocs
@@ -150,6 +155,8 @@ class SplatOpts:
     ld_generate_symbol_per_data_segment: bool
     # Sets the default option for the `bss_contains_common` attribute of all segments.
     ld_bss_contains_common: bool
+    # Specify an expression to be used for the `_gp` symbol in the generated linker script instead of a hardcoded value.
+    ld_gp_expression: Optional[str]
 
     ################################################################################
     # C file options
@@ -400,6 +407,21 @@ def _parse_yaml(
         else:
             raise ValueError(f"Invalid endianness: {endianness}")
 
+    def parse_include_asm_macro_style() -> Literal["default", "maspsx_hack"]:
+        include_asm_macro_style = p.parse_opt_within(
+            "include_asm_macro_style",
+            str,
+            ["default", "maspsx_hack"],
+            "default",
+        )
+
+        if include_asm_macro_style == "default":
+            return "default"
+        elif include_asm_macro_style == "maspsx_hack":
+            return "maspsx_hack"
+        else:
+            raise ValueError(f"Invalid endianness: {include_asm_macro_style}")
+
     default_ld_bss_is_noload = True
     if platform == "psx":
         default_ld_bss_is_noload = False
@@ -431,6 +453,7 @@ def _parse_yaml(
             "generated_macro_inc_content", str
         ),
         generate_asm_macros_files=p.parse_opt("generate_asm_macros_files", bool, True),
+        include_asm_macro_style=parse_include_asm_macro_style(),
         use_o_as_suffix=p.parse_opt("o_as_suffix", bool, False),
         gp=p.parse_optional_opt("gp_value", int),
         check_consecutive_segment_types=p.parse_opt(
@@ -507,6 +530,9 @@ def _parse_yaml(
             "ld_generate_symbol_per_data_segment", bool, False
         ),
         ld_bss_contains_common=p.parse_opt("ld_bss_contains_common", bool, False),
+        ld_gp_expression=p.parse_optional_opt_with_default(
+            "ld_gp_expression", str, None
+        ),
         create_c_files=p.parse_opt("create_c_files", bool, True),
         auto_decompile_empty_functions=p.parse_opt(
             "auto_decompile_empty_functions", bool, True

splat/util/symbols.py

@@ -192,6 +192,28 @@ def handle_sym_addrs(
                             if attr_name == "function_owner":
                                 sym.function_owner = attr_val
                                 continue
+                            if attr_name == "align":
+                                align = int(attr_val, 0)
+
+                                if align < 0:
+                                    log.parsing_error_preamble(path, line_num, line)
+                                    log.error(
+                                        f"The given alignment for '{sym.name}' (0x{sym.vram_start:08X}) is negative."
+                                    )
+                                align_shift = (align & (-align)).bit_length() - 1
+                                if (1 << align_shift) != align:
+                                    log.parsing_error_preamble(path, line_num, line)
+                                    log.error(
+                                        f"The given alignment '0x{align:X}' for symbol '{sym.name}' (0x{sym.vram_start:08X}) is not a power of two."
+                                    )
+                                if sym.vram_start % align != 0:
+                                    log.parsing_error_preamble(path, line_num, line)
+                                    log.error(
+                                        f"The symbol '{sym.name}' (0x{sym.vram_start:08X}) is not aligned already to the given alignment '0x{align:X}'."
+                                    )
+
+                                sym.given_align = align
+                                continue
                         except:
                             log.parsing_error_preamble(path, line_num, line)
                             log.write(
@@ -520,6 +542,8 @@ def add_symbol_to_spim_segment(
         context_sym.nameEnd = sym.given_name_end
     if sym.given_visibility:
         context_sym.visibility = sym.given_visibility
+    if sym.given_align:
+        context_sym.setAlignment(sym.given_align)
 
     return context_sym
 
@@ -568,6 +592,8 @@ def add_symbol_to_spim_section(
         context_sym.nameEnd = sym.given_name_end
     if sym.given_visibility:
         context_sym.visibility = sym.given_visibility
+    if sym.given_align:
+        context_sym.setAlignment(sym.given_align)
 
     return context_sym
 
@@ -667,6 +693,8 @@ class Symbol:
     given_filename: Optional[str] = None
     given_visibility: Optional[str] = None
 
+    given_align: Optional[int] = None
+
     _generated_default_name: Optional[str] = None
     _last_type: Optional[str] = None
 

{splat64-0.35.2.dist-info → splat64-0.36.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splat64
-Version: 0.35.2
+Version: 0.36.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
@@ -42,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.36.0; extra == 'dev'
+Requires-Dist: spimdisasm<2.0.0,>=1.36.1; extra == 'dev'
 Requires-Dist: types-colorama; extra == 'dev'
 Requires-Dist: types-pyyaml; extra == 'dev'
 Provides-Extra: mips
@@ -50,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.36.0; extra == 'mips'
+Requires-Dist: spimdisasm<2.0.0,>=1.36.1; extra == 'mips'
 Description-Content-Type: text/markdown
 
 # splat
@@ -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.35.2,<1.0.0
+splat64[mips]>=0.36.1,<1.0.0
 ```
 
 ### Optional dependencies

{splat64-0.35.2.dist-info → splat64-0.36.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-splat/__init__.py,sha256=plXxTGxbR0ohNAzhonKhmbJtAvjkwe9BvuQc78b0vbI,291
+splat/__init__.py,sha256=DNgsNxB7n0GQjvlsa29pMAyW2yISvkOzadiTCjitUhg,291
 splat/__main__.py,sha256=T333dHDgr-2HYYhtARnYMEjdECnYiNIKfcXDD99o22A,732
 splat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 splat/disassembler/__init__.py,sha256=IubLMnm_F5cZ7WUPBfk1VJ7vdj6i1if5GG6RBvEoBEA,226
@@ -6,7 +6,7 @@ splat/disassembler/disassembler.py,sha256=2ynehZRz1P6UnaBk6DWRy4c3ynRnnWApMhf0K9
 splat/disassembler/disassembler_instance.py,sha256=09GW7QYoNolgE2wnO7ALngw_CxgF-mfyLiXBsyv22jA,916
 splat/disassembler/disassembler_section.py,sha256=J9jtplQVDVeGBmyEOcMpC3Hv3DyecqaNjlYc7zqEqDI,7459
 splat/disassembler/null_disassembler.py,sha256=jYuDMtfPiBifwz0H-ZHLMWtpGa19X_iLgy4K-dQhPYY,328
-splat/disassembler/spimdisasm_disassembler.py,sha256=raJaya8QVw90mhtISf-atp0fLnc-IkciRbLIVRqdPx4,5920
+splat/disassembler/spimdisasm_disassembler.py,sha256=BPeWrTIla14DtkDl3apHxoMkd26mhkJPJndwSX-MpF0,5920
 splat/platforms/__init__.py,sha256=qjqKi63k5N3DUdILNfuk6qpJJkVeAWpjAs36L97vvP4,100
 splat/platforms/n64.py,sha256=kgWr6nesGC0X-qVydmu8tSq48NbqVf9mF6EyqvUuoUM,421
 splat/platforms/ps2.py,sha256=QI_8Ve43LZeNqpuk8_CFxIqsNJpMTacRHXdZVh3iY6c,336
@@ -14,10 +14,10 @@ splat/platforms/psp.py,sha256=rCr_uf1SuHNaMUXjIC0GyoA_463OQZv0se2KMarWry0,125
 splat/platforms/psx.py,sha256=YxQERdOBr4p3ab9Wk80FNhVYi-uvmh7p_jeykSFp23M,40
 splat/scripts/__init__.py,sha256=OY0nHg6a7JB437Sb96qLbZ_7ByVsal1gStj35wJAI_Y,101
 splat/scripts/capy.py,sha256=svbOfLO34-QN3xLiBy9vk2RGs_To8TWMWEKBw6yx2xQ,3674
-splat/scripts/create_config.py,sha256=nWLqbvjZW7LCQsJvvsxEWgnCfN-A_WDwxpV7VlRE-4I,11520
+splat/scripts/create_config.py,sha256=ZQrqdewjR2poVhlvoa0CVZMfr9vnupYGouaAn2MLph4,11783
 splat/scripts/split.py,sha256=081pZYN34iriEhMmDBDxxLrDkSKkAksHJydzQ0VAEGk,21933
 splat/segtypes/__init__.py,sha256=-upUw_4JGQtvyp6IfTMzOq_CK3xvVaT_0K0_EipHyOo,208
-splat/segtypes/linker_entry.py,sha256=vr8OSC0cnsaNIsePgBMqcHlCLtr2mdZz0jflYT3t3UY,24780
+splat/segtypes/linker_entry.py,sha256=oTpt9Iw9ybrmwrkacyH5RYzj01wGTT7vjeE3xE1Og38,24908
 splat/segtypes/segment.py,sha256=-wc5xpWMN8AO8S3rrtibJgw0MMk2Dm1lZSI8dQj-H20,30625
 splat/segtypes/common/__init__.py,sha256=mnq0acScilSCCo6q2PvkDk0Or3V8qitA7I8QMVw8haI,631
 splat/segtypes/common/asm.py,sha256=k3p4vgbQJP40iyTgQkIci1j3CpKkWksqoWBx2Pb2oh8,703
@@ -44,7 +44,7 @@ splat/segtypes/common/rodatabin.py,sha256=uqp60QuwHwvlMwHq0nZrU3y3yYcHbv2twT0PID
 splat/segtypes/common/sbss.py,sha256=blIEuVYie4qNEOYMmlSdltn5f4MvgJu3AV8vqVD8Nh4,131
 splat/segtypes/common/sdata.py,sha256=dnLzNSNtSyclLZiNUmFTv0e0BWN8glxB1km1MSRq6xY,136
 splat/segtypes/common/segment.py,sha256=vVFyFjs-gS5qIWO8Pd0pMJYxboP-iBRKvxcDV8YxdYM,94
-splat/segtypes/common/textbin.py,sha256=kC0m9RDxavpQt2WAYnXQVUzLlIZUvd9hqC3KEz7CUKs,5239
+splat/segtypes/common/textbin.py,sha256=PXEb1JQB2NEqVDLg5KW2vI0NLSqrROJvCOifxB0NUms,5994
 splat/segtypes/n64/__init__.py,sha256=tf2yWlijeKmOp1OhEEL-aW88mU-mWQRC2lSjQ5Ww1eI,569
 splat/segtypes/n64/ci.py,sha256=An7wIHcoZ89KiGCKpCRbM7IrmDNYBidXT-6kjKn2vH0,2400
 splat/segtypes/n64/ci4.py,sha256=ZP8e12CpV8U7r8oLnb9uHc-MkmBbxjXBbJxROFvOjiM,184
@@ -52,7 +52,7 @@ splat/segtypes/n64/ci8.py,sha256=tS4USmp0LuJnP-UlgaOYoxvYxBKgE67wYCz-KeRLlFk,184
 splat/segtypes/n64/decompressor.py,sha256=YuKo-PS_S2-Ow1Zw8QTO70NWlSYTY79JZN0kUQB7T0U,1779
 splat/segtypes/n64/gfx.py,sha256=f22_P8aXjQ0PiWf3iLztfERfmvRfDBcA00CBIwKutvw,8395
 splat/segtypes/n64/header.py,sha256=7Ubmvs49FTK1h4GX58XHOa922bbmjpOJCY3QXvd9078,2018
-splat/segtypes/n64/i1.py,sha256=tnYXJxyM802jJ6OFBLJK9FGfWLaMg0UqTqZeascnAxw,213
+splat/segtypes/n64/i1.py,sha256=Mr7YRdKpvuTGu7P5QZPo6PF1XOcVy4W6_zthcRkLKps,204
 splat/segtypes/n64/i4.py,sha256=wPYCGNa4dQHKf8lbDijSD80_yOt9kQIgOQO6ZOB_pGA,204
 splat/segtypes/n64/i8.py,sha256=5zqYmpmuXprEzwidVQTknSKqMuu0C1Izk4t5ILoTPf4,204
 splat/segtypes/n64/ia16.py,sha256=y1uLVuh72HTmyAEK90R67vftp-X4LDgRxgJyU8EAnH0,208
@@ -80,14 +80,14 @@ splat/util/cache_handler.py,sha256=N0SggmvYwh0k-0fngHXoHG1CosC2rCsnlCTDsG8z5aE,1
 splat/util/color.py,sha256=FSmy0dAQJ9FzRBc99Yt4kBEyB62MC_YiVkqoWgPMsRU,371
 splat/util/compiler.py,sha256=uXShMm49380ENecSFlsi75LWI45yakWkExZX8NT5pOU,1778
 splat/util/conf.py,sha256=aM6O2QikosjL95pCxI2FcCxrwDsLP8T8sRf2Uev_Pac,3236
-splat/util/file_presets.py,sha256=i7kqRCNJ_LjIY1xnc9pyAh690SAA4-cZPotJL_LnpvM,17425
+splat/util/file_presets.py,sha256=ufSZdeYi3uXos363FmzLfzNMNiTgJq_yMTZAcgRdjw8,18540
 splat/util/log.py,sha256=aJA1rg8IirJu1wGzjNuATHvepYvD3k5CtEyMasyJWxI,1193
-splat/util/options.py,sha256=KqNjeB2mSwuB09H3uylfZ9PU7GlCZDYhkhfCLAGYSQE,30005
+splat/util/options.py,sha256=bXFruGE-tcqsdM0nYNqf_IQIiqxFCxn7NWEo_igOZIc,31252
 splat/util/palettes.py,sha256=d3KoZnwt-zunI9eNwb3txysXg4DY3xnF0O5aQRxM4so,2920
 splat/util/progress_bar.py,sha256=41VehpIFK1cphENaXV_Aq6_3mFx25eQ8V7Z51SKFPeM,166
 splat/util/relocs.py,sha256=rVkPGUXzGZUyY_z7oaCTUxaZH1-lPxxiZwSJvLA0JB0,4156
 splat/util/statistics.py,sha256=8C88vLW8q4Xd4i1Crz8X24NLoraLyKd0lw3ebbeonSo,1906
-splat/util/symbols.py,sha256=CMYn6dQDJJEx6bd6IHai8jnqkRwC3EkLdtvMJWz4AlM,29688
+splat/util/symbols.py,sha256=VNTTTLKQFMx6y1XfmK95cwUzKuAtFPTh-MjxfXbV-aw,31270
 splat/util/utils.py,sha256=EtuU2f7S3vI8kH9C9KaIpjANsUCUkoFz4VBNLWK9lQY,187
 splat/util/vram_classes.py,sha256=UH4rkugEwoec_-alJ4smNOcnU51G-V5OG7Pfsj47eaM,3491
 splat/util/n64/__init__.py,sha256=hsBkPh6NUz-bW7HVspcNZ0mCxBhdfcPC07_7gbga95o,84
@@ -95,8 +95,8 @@ splat/util/n64/find_code_length.py,sha256=uUoPoUORAjsAvH8oGqwnGvw6j8I_NnSrZtA-x9
 splat/util/n64/rominfo.py,sha256=s13r4pDPH9Mc43ZGpomPnLZPWchhbv0kIjDoM0B3Ong,16963
 splat/util/psx/__init__.py,sha256=kCCaR-KB1mNlIcXB4OuuSQ2zVLbWg_SnIZIUeyjeBBI,39
 splat/util/psx/psxexeinfo.py,sha256=MrxY28nes0uzpFmCz0o9JFbF8s1eQRQNOpC_82wsMVI,5725
-splat64-0.35.2.dist-info/METADATA,sha256=lsfohLB5MYUUzM3LB-hLB06byuE64aJkO1hCIJ6snw4,3830
-splat64-0.35.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splat64-0.35.2.dist-info/entry_points.txt,sha256=O7Xy-qNOHcI87-OQrWJ-OhRDws74SuwVb_4rtnp0eLo,52
-splat64-0.35.2.dist-info/licenses/LICENSE,sha256=97VMVzjG8yQvsf8NG2M9IFSbh7R8cifJnc6QK1cZqj8,1070
-splat64-0.35.2.dist-info/RECORD,,
+splat64-0.36.1.dist-info/METADATA,sha256=KinjZck6hH8X_-gX2ZlaaFPquW5GdObwaPS2ltPMNdc,3830
+splat64-0.36.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splat64-0.36.1.dist-info/entry_points.txt,sha256=O7Xy-qNOHcI87-OQrWJ-OhRDws74SuwVb_4rtnp0eLo,52
+splat64-0.36.1.dist-info/licenses/LICENSE,sha256=97VMVzjG8yQvsf8NG2M9IFSbh7R8cifJnc6QK1cZqj8,1070
+splat64-0.36.1.dist-info/RECORD,,