splat64 0.34.3__py3-none-any.whl → 0.35.0__py3-none-any.whl

splat/util/n64/rominfo.py

@@ -11,7 +11,7 @@ import zlib
 from dataclasses import dataclass
 
 from pathlib import Path
-from typing import Optional
+from typing import Optional, List
 
 import rabbitizer
 import spimdisasm
@@ -69,18 +69,43 @@ crc_to_cic = {
 unknown_cic = CIC("unknown", "unknown", 0x0000000)
 
 
+@dataclass
+class EntryAddressInfo:
+    value: int
+    rom_hi: int
+    rom_lo: int
+
+    @staticmethod
+    def new(
+        value: Optional[int], hi: Optional[int], lo: Optional[int]
+    ) -> Optional["EntryAddressInfo"]:
+        if value is not None and hi is not None and lo is not None:
+            return EntryAddressInfo(value, hi, lo)
+        return None
+
+
 @dataclass
 class N64EntrypointInfo:
     entry_size: int
-    data_size: int
-    bss_start_address: Optional[int]
-    bss_size: Optional[int]
-    main_address: Optional[int]
-    stack_top: int
+    data_size: Optional[int]
+    bss_start_address: Optional[EntryAddressInfo]
+    bss_size: Optional[EntryAddressInfo]
+    bss_end_address: Optional[EntryAddressInfo]
+    main_address: Optional[EntryAddressInfo]
+    stack_top: Optional[EntryAddressInfo]
     traditional_entrypoint: bool
 
     def segment_size(self) -> int:
-        return self.entry_size + self.data_size
+        if self.data_size is not None:
+            return self.entry_size + self.data_size
+        return self.entry_size
+
+    def get_bss_size(self) -> Optional[int]:
+        if self.bss_size is not None:
+            return self.bss_size.value
+        if self.bss_start_address is not None and self.bss_end_address is not None:
+            return self.bss_end_address.value - self.bss_start_address.value
+        return None
 
     @staticmethod
     def parse_rom_bytes(
@@ -93,23 +118,27 @@ class N64EntrypointInfo:
 
         register_values = [0 for _ in range(32)]
         completed_pair = [False for _ in range(32)]
+        hi_assignments: List[Optional[int]] = [None for _ in range(32)]
+        lo_assignments: List[Optional[int]] = [None for _ in range(32)]
 
         register_bss_address: Optional[int] = None
         register_bss_size: Optional[int] = None
         register_main_address: Optional[int] = None
 
-        bss_address: Optional[int] = None
-        bss_size: Optional[int] = None
+        bss_address: Optional[EntryAddressInfo] = None
+        bss_size: Optional[EntryAddressInfo] = None
+        bss_end_address: Optional[EntryAddressInfo] = None
 
         traditional_entrypoint = True
         decrementing_bss_routine = True
-        data_size = 0
-        func_call_target: Optional[int] = None
+        data_size: Optional[int] = None
+        func_call_target: Optional[EntryAddressInfo] = None
 
         size = 0
         i = 0
         while i < len(word_list):
             word = word_list[i]
+            current_rom = offset + i * 4
             insn = rabbitizer.Instruction(word, vram)
             if not insn.isValid():
                 break
@@ -121,6 +150,7 @@ class N64EntrypointInfo:
             elif insn.canBeHi():
                 register_values[insn.rt.value] = insn.getProcessedImmediate() << 16
                 completed_pair[insn.rt.value] = False
+                hi_assignments[insn.rt.value] = current_rom
             elif insn.canBeLo():
                 if insn.isLikelyHandwritten():
                     # Try to skip these instructions:
@@ -132,6 +162,8 @@ class N64EntrypointInfo:
                         register_values[insn.rs.value] + insn.getProcessedImmediate()
                     )
                     completed_pair[insn.rt.value] = True
+                    if not insn.isUnsigned():
+                        lo_assignments[insn.rt.value] = current_rom
                 elif insn.doesStore():
                     if insn.rt == rabbitizer.RegGprO32.zero:
                         # Try to detect the zero-ing bss algorithm
@@ -173,16 +205,25 @@ class N64EntrypointInfo:
                 # bnez       $at, .clear_bss
                 #  sw        $zero, -0x4($t0)
                 if bss_address is None and bss_size is None:
-                    bss_address = register_values[insn.rs.value]
-                    bss_end_address = register_values[insn.rt.value]
-                    bss_size = bss_end_address - bss_address
+                    bss_address = EntryAddressInfo.new(
+                        register_values[insn.rs.value],
+                        hi_assignments[insn.rs.value],
+                        lo_assignments[insn.rs.value],
+                    )
+                    bss_end_address = EntryAddressInfo.new(
+                        register_values[insn.rt.value],
+                        hi_assignments[insn.rt.value],
+                        lo_assignments[insn.rt.value],
+                    )
 
             elif insn.isFunctionCall():
                 # Some games don't follow the usual pattern for entrypoints.
                 # Those usually use `jal` instead of `jr` to jump out of the
                 # entrypoint to actual code.
                 traditional_entrypoint = False
-                func_call_target = insn.getInstrIndexAsVram()
+                func_call_target = EntryAddressInfo(
+                    insn.getInstrIndexAsVram(), current_rom, current_rom
+                )
 
             elif insn.uniqueId == rabbitizer.InstrId.cpu_break:
                 traditional_entrypoint = False
@@ -209,27 +250,38 @@ class N64EntrypointInfo:
         #         print(i, f"{val:08X}")
 
         if decrementing_bss_routine:
-            bss_address = (
-                register_values[register_bss_address]
-                if register_bss_address is not None
-                else None
+            if register_bss_address is not None:
+                bss_address = EntryAddressInfo.new(
+                    register_values[register_bss_address],
+                    hi_assignments[register_bss_address],
+                    lo_assignments[register_bss_address],
+                )
+            if register_bss_size is not None:
+                bss_size = EntryAddressInfo.new(
+                    register_values[register_bss_size],
+                    hi_assignments[register_bss_size],
+                    lo_assignments[register_bss_size],
+                )
+
+        if register_main_address is not None:
+            main_address = EntryAddressInfo.new(
+                register_values[register_main_address],
+                hi_assignments[register_main_address],
+                lo_assignments[register_main_address],
             )
-            bss_size = (
-                register_values[register_bss_size]
-                if register_bss_size is not None
-                else None
-            )
-        main_address = (
-            register_values[register_main_address]
-            if register_main_address is not None
-            else None
+        else:
+            main_address = None
+
+        stack_top = EntryAddressInfo.new(
+            register_values[rabbitizer.RegGprO32.sp.value],
+            hi_assignments[rabbitizer.RegGprO32.sp.value],
+            lo_assignments[rabbitizer.RegGprO32.sp.value],
         )
-        stack_top = register_values[rabbitizer.RegGprO32.sp.value]
 
         if not traditional_entrypoint:
             if func_call_target is not None:
                 main_address = func_call_target
-                if func_call_target > vram:
+                if func_call_target.value > vram:
                     # Some weird-entrypoint games have non-code between the
                     # entrypoint and the actual user code.
                     # We try to find where actual code may begin, and tag
@@ -244,6 +296,7 @@ class N64EntrypointInfo:
             data_size,
             bss_address,
             bss_size,
+            bss_end_address,
             main_address,
             stack_top,
             traditional_entrypoint,

splat/util/options.py

@@ -35,6 +35,9 @@ class SplatOpts:
     generated_c_preamble: str
     # Determines the code that is inserted by default in generated .s files
     generated_s_preamble: str
+    # Determines any extra content to be added in the generated macro.inc file
+    generated_macro_inc_content: Optional[str]
+    generate_asm_macros_files: bool
     # 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
@@ -187,8 +190,12 @@ class SplatOpts:
     asm_data_macro: str
     # Determines the macro used at the end of a function, such as endlabel or .end
     asm_end_label: str
+    # Determines the macro used at the end of a data symbol, such as enddlabel
+    asm_data_end_label: str
     # Determines the macro used to declare ehtable labels in asm files
     asm_ehtable_label_macro: str
+    # Determines the macro used to declare the given symbol is a non matching one.
+    asm_nonmatching_label_macro: str
     # Toggles the .size directive emitted by the disassembler
     asm_emit_size_directive: Optional[bool]
     # Determines the number of characters to left align before the TODO finish documenting
@@ -420,6 +427,10 @@ def _parse_yaml(
             "generated_c_preamble", str, '#include "common.h"'
         ),
         generated_s_preamble=p.parse_opt("generated_s_preamble", str, ""),
+        generated_macro_inc_content=p.parse_optional_opt(
+            "generated_macro_inc_content", str
+        ),
+        generate_asm_macros_files=p.parse_opt("generate_asm_macros_files", bool, True),
         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(
@@ -523,9 +534,15 @@ def _parse_yaml(
         ),
         asm_data_macro=p.parse_opt("asm_data_macro", str, comp.asm_data_macro),
         asm_end_label=p.parse_opt("asm_end_label", str, comp.asm_end_label),
+        asm_data_end_label=p.parse_opt(
+            "asm_data_end_label", str, comp.asm_data_end_label
+        ),
         asm_ehtable_label_macro=p.parse_opt(
             "asm_ehtable_label_macro", str, comp.asm_ehtable_label_macro
         ),
+        asm_nonmatching_label_macro=p.parse_opt(
+            "asm_nonmatching_label_macro", str, comp.asm_nonmatching_label_macro
+        ),
         asm_emit_size_directive=asm_emit_size_directive,
         mnemonic_ljust=p.parse_opt("mnemonic_ljust", int, 11),
         rom_address_padding=p.parse_opt("rom_address_padding", bool, False),

splat/util/relocs.py

@@ -38,10 +38,8 @@ def initialize():
         prog_bar.set_description(f"Loading relocs ({path.stem})")
         line: str
         for line_num, line in enumerate(prog_bar):
-            line = line.strip()
             # Allow comments
-            line = line.split("//")[0]
-            line = line.strip()
+            line = line.split("//")[0].strip()
 
             if line == "":
                 continue

{splat64-0.34.3.dist-info → splat64-0.35.0.dist-info}/METADATA

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

{splat64-0.34.3.dist-info → splat64-0.35.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-splat/__init__.py,sha256=rs-XlFGaAdeRR2HH39ZlivuX9gxbNCbXUC7SGTt7kks,291
+splat/__init__.py,sha256=tcpQ8WekepdS0S7Aj4YCScLZqmoGaESYrKYng4wJRPI,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=Lj6zp2g7Jo4sRlZ7CavLb7qM4alzEG1n7AhFYLiskqU,5685
+splat/disassembler/spimdisasm_disassembler.py,sha256=raJaya8QVw90mhtISf-atp0fLnc-IkciRbLIVRqdPx4,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,11 +14,11 @@ 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=nFwIt1UWzlWE9C3i-2dGsVyGX2cuXzIqkp2kur2-pdE,7670
-splat/scripts/split.py,sha256=pzNPJRy11YwIA_2wbRYU2m-zIfBRpo2RySJ9nKVBqRI,19433
+splat/scripts/create_config.py,sha256=nWLqbvjZW7LCQsJvvsxEWgnCfN-A_WDwxpV7VlRE-4I,11520
+splat/scripts/split.py,sha256=081pZYN34iriEhMmDBDxxLrDkSKkAksHJydzQ0VAEGk,21933
 splat/segtypes/__init__.py,sha256=-upUw_4JGQtvyp6IfTMzOq_CK3xvVaT_0K0_EipHyOo,208
-splat/segtypes/linker_entry.py,sha256=e2IzjAWC1B_JCx5pxBdKJrzOCse4SYUBrLHM8l3AR3o,24765
-splat/segtypes/segment.py,sha256=UByBPNSNb5AThjx2J9PspeQALobc-4_jh0qKQ9ycEjg,30281
+splat/segtypes/linker_entry.py,sha256=vr8OSC0cnsaNIsePgBMqcHlCLtr2mdZz0jflYT3t3UY,24780
+splat/segtypes/segment.py,sha256=-wc5xpWMN8AO8S3rrtibJgw0MMk2Dm1lZSI8dQj-H20,30625
 splat/segtypes/common/__init__.py,sha256=mnq0acScilSCCo6q2PvkDk0Or3V8qitA7I8QMVw8haI,631
 splat/segtypes/common/asm.py,sha256=k3p4vgbQJP40iyTgQkIci1j3CpKkWksqoWBx2Pb2oh8,703
 splat/segtypes/common/asmtu.py,sha256=C52kKh-8YeDHu0EucEfQ-tQMtDgfKfwAJ6wwiW6nOBU,354
@@ -32,7 +32,7 @@ splat/segtypes/common/data.py,sha256=r9G_vYieNlRze-5wGOKFazvFjpuodfSLad6iCNsBOAU
 splat/segtypes/common/databin.py,sha256=ucbbsc_M1332KifjExuDsf1wqm4-GZAiLqOwwrUwUpQ,1194
 splat/segtypes/common/eh_frame.py,sha256=MzL373ej2E38leM47py3T5beLq2IolsYszLZM8PYS2Y,913
 splat/segtypes/common/gcc_except_table.py,sha256=-ZrQL5dCcRu7EPFFPgL8lIJwWL5FsEeeQoSUVfTkyIg,2112
-splat/segtypes/common/group.py,sha256=4g8jrpUjlsvxFuFRauS4rdxTvAAePebc941fQj96qEA,6197
+splat/segtypes/common/group.py,sha256=wSrNQXWJpRZl8-cHtdlFy08TQDI_n7QAsYhUsCRb7Bs,7125
 splat/segtypes/common/hasm.py,sha256=3mr8k8SNLGD7r0nBU3o6AQ05tnsD-skg9mdVap0kH38,782
 splat/segtypes/common/header.py,sha256=NspQdk-L69j9dOBzBtDKb7bc11Gwa0WDWIVCd2P4mfE,1257
 splat/segtypes/common/lib.py,sha256=WaJH0DH0B8iJvhYQWYBjThbNeEXz3Yh7E8ZyONe5JtQ,2349
@@ -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=wDc-951nci08nz1Gb_DByMTAKwsyT4wQD5m4ZQRdD7o,4695
+splat/segtypes/common/textbin.py,sha256=kC0m9RDxavpQt2WAYnXQVUzLlIZUvd9hqC3KEz7CUKs,5239
 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
@@ -75,27 +75,28 @@ splat/segtypes/ps2/vtables.py,sha256=c8weQcbQ0-KkjkLHUXViTWkEaJ6LNR8jBUMV-0t0m4o
 splat/segtypes/psp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 splat/segtypes/psx/__init__.py,sha256=tn0oDYUPtF0PfC8I4G23nPvH_JAcuLGxOCvYN1SE3Dc,31
 splat/segtypes/psx/header.py,sha256=2S8XG_6zfLGzmEA0XpFqs0-4nf52YD9Erk6SbMUlVzo,2639
-splat/util/__init__.py,sha256=3-jgYUssL84IgaR_JF1hSb-lN4ru0gJQTrjP_UGEWu8,470
+splat/util/__init__.py,sha256=rsnoPNjNVbu9j_yxoubyq8Pf-clIbOHk2vQyuKSmxyI,513
 splat/util/cache_handler.py,sha256=N0SggmvYwh0k-0fngHXoHG1CosC2rCsnlCTDsG8z5aE,1852
 splat/util/color.py,sha256=FSmy0dAQJ9FzRBc99Yt4kBEyB62MC_YiVkqoWgPMsRU,371
-splat/util/compiler.py,sha256=xDDNdnutmkB7T21j-BccBMdkA2leU3GzXuTYEWgVgNw,1530
+splat/util/compiler.py,sha256=uXShMm49380ENecSFlsi75LWI45yakWkExZX8NT5pOU,1778
 splat/util/conf.py,sha256=aM6O2QikosjL95pCxI2FcCxrwDsLP8T8sRf2Uev_Pac,3236
+splat/util/file_presets.py,sha256=6GLLNUQ_Gpi7tZUYdtfU-3pVcjkAJeByMtFZRmDqjEg,16735
 splat/util/log.py,sha256=aJA1rg8IirJu1wGzjNuATHvepYvD3k5CtEyMasyJWxI,1193
-splat/util/options.py,sha256=iIwI3ZVbwWNIK4_0BIe3Iu9NxhEfIoXyjVGWgjPmG-Q,29157
+splat/util/options.py,sha256=KqNjeB2mSwuB09H3uylfZ9PU7GlCZDYhkhfCLAGYSQE,30005
 splat/util/palettes.py,sha256=d3KoZnwt-zunI9eNwb3txysXg4DY3xnF0O5aQRxM4so,2920
 splat/util/progress_bar.py,sha256=41VehpIFK1cphENaXV_Aq6_3mFx25eQ8V7Z51SKFPeM,166
-splat/util/relocs.py,sha256=cgQYSaAtNpLlUZQdhEfa7ZpI8i0HqoDhwB88QtFqdJs,4212
+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/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
 splat/util/n64/find_code_length.py,sha256=uUoPoUORAjsAvH8oGqwnGvw6j8I_NnSrZtA-x9h9h7E,1414
-splat/util/n64/rominfo.py,sha256=U6TieblUAmxhZsn7u8nbjOKkbC6ygsC_7IiLLaOWwUE,14646
+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.34.3.dist-info/METADATA,sha256=xhykQMnkqSDdoSyfjO3ovNl0-eDvHyFUR-u26YlYa_E,3830
-splat64-0.34.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splat64-0.34.3.dist-info/entry_points.txt,sha256=O7Xy-qNOHcI87-OQrWJ-OhRDws74SuwVb_4rtnp0eLo,52
-splat64-0.34.3.dist-info/licenses/LICENSE,sha256=97VMVzjG8yQvsf8NG2M9IFSbh7R8cifJnc6QK1cZqj8,1070
-splat64-0.34.3.dist-info/RECORD,,
+splat64-0.35.0.dist-info/METADATA,sha256=C9xglffpmD6eI4pgKFqTAa_g8zhMnORj-N7puPU62RU,3830
+splat64-0.35.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splat64-0.35.0.dist-info/entry_points.txt,sha256=O7Xy-qNOHcI87-OQrWJ-OhRDws74SuwVb_4rtnp0eLo,52
+splat64-0.35.0.dist-info/licenses/LICENSE,sha256=97VMVzjG8yQvsf8NG2M9IFSbh7R8cifJnc6QK1cZqj8,1070
+splat64-0.35.0.dist-info/RECORD,,