splat64 0.35.0__tar.gz → 0.35.2__tar.gz

{splat64-0.35.0 → splat64-0.35.2}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # splat Release Notes
 
+### 0.35.2
+
+* Miscellaneous updates to generated macro labels.
+  * `jlabel`s in `labels.inc` are now explicitly marked as local.
+  * `jlabel`s in `macro.inc` no longer are marked as `@function` type.
+  * `macro.inc` now has include guards.
+    * `labels.inc` does not have them because no old assembler seem to properly support them.
+* Fix splat not respecting when `generate_asm_macros_files` was being turned off.
+
+### 0.35.1
+
+* Fixes issues in the generated `macro.inc` and `labels.inc` files on psx projects.
+* Change `jlabel`s to be global if the user has turned off rodata migration to functions.
+
 ### 0.35.0
 
 * Add `pair_segment` option to segments.

{splat64-0.35.0 → splat64-0.35.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splat64
-Version: 0.35.0
+Version: 0.35.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
@@ -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.32.0; extra == 'dev'
+Requires-Dist: spimdisasm<2.0.0,>=1.36.0; 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.32.0; extra == 'mips'
+Requires-Dist: spimdisasm<2.0.0,>=1.36.0; 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.0,<1.0.0
+splat64[mips]>=0.35.2,<1.0.0
 ```
 
 ### Optional dependencies

{splat64-0.35.0 → splat64-0.35.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.35.0,<1.0.0
+splat64[mips]>=0.35.2,<1.0.0
 ```
 
 ### Optional dependencies

{splat64-0.35.0 → splat64-0.35.2}/docs/Segments.md

@@ -189,9 +189,9 @@ Data located in the ROM that is linked from a C file. Use the `.data` segment to
 
 **NOTE:** `splat` will not generate any `.data.s` files for these `.` (dot) sections.
 
-## `.sdata`
+## `sdata` / `.sdata`
 
-The `.sdata` segment behaves the same as the `.data` segment but supports "small data" linker sections named `.sdata`.
+The `sdata` and `.sdata` segments behaves the same as the `data` and `.data` segments, but supports "small data" linker sections.
 
 ## `rodata`
 
@@ -263,9 +263,9 @@ Links the `.bss` section of the associated `c` file.
 - { start: 0x7D1AD0, type: .bss, name: filepath, vram: 0x803C0420 }
 ```
 
-## `.sbss`
+## `sbss` / `.sbss`
 
-The `.sbss` segment behaves the same as the `.bss` segment but supports "small bss" linker sections named `.sbss`.
+The `sbss` and `.sbss` segments behaves the same as the `bss` and `.bss` segments, but supports "small bss" linker sections.
 
 ## `lib`
 

{splat64-0.35.0 → splat64-0.35.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "splat64"
 # Should be synced with src/splat/__init__.py
-version = "0.35.0"
+version = "0.35.2"
 description = "A binary splitting tool to assist with decompilation and modding projects"
 readme = "README.md"
 license = {file = "LICENSE"}
@@ -20,7 +20,7 @@ dependencies = [
 
 [project.optional-dependencies]
 mips = [
-    "spimdisasm>=1.32.0,<2.0.0", # This value should be keep in sync with the version listed on disassembler/spimdisasm_disassembler.py
+    "spimdisasm>=1.36.0,<2.0.0", # This value should be keep in sync with the version listed on disassembler/spimdisasm_disassembler.py
     "rabbitizer>=1.12.0,<2.0.0",
     "pygfxd",
     "n64img>=0.3.3",

{splat64-0.35.0 → splat64-0.35.2}/src/splat/__init__.py

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

{splat64-0.35.0 → splat64-0.35.2}/src/splat/util/file_presets.py

@@ -14,6 +14,9 @@ from . import options, log
 
 
 def write_all_files():
+    if not options.opts.generate_asm_macros_files:
+        return
+
     write_include_asm_h()
     write_assembly_inc_files()
 
@@ -122,20 +125,26 @@ def write_assembly_inc_files():
         options.opts.asm_jtbl_label_macro != ""
         and options.opts.asm_jtbl_label_macro != options.opts.asm_function_macro
     ):
-        jlabel_macro_labelsinc = f"""
+        jlabel_macro_macroinc = f"""
 # A label referenced by a jumptable.
 .macro {options.opts.asm_jtbl_label_macro} label, visibility=global
+    .\\visibility \\label
     \\label:
 .endm
 """
-        jlabel_macro_macroinc = f"""
+        if options.opts.migrate_rodata_to_functions:
+            jlabel_macro_labelsinc = f"""
 # A label referenced by a jumptable.
-.macro {options.opts.asm_jtbl_label_macro} label, visibility=global
+.macro {options.opts.asm_jtbl_label_macro} label, visibility=local
     .\\visibility \\label
-    .type \\label, @function
     \\label:
 .endm
 """
+        else:
+            # If the user doesn't migrate rodata, like jumptables, to functions
+            # then the user will need jlabels to be global instead of local,
+            # so we just reuse the definition from macro.inc
+            jlabel_macro_labelsinc = jlabel_macro_macroinc
 
     data_macros = ""
     if (
@@ -170,12 +179,6 @@ def write_assembly_inc_files():
 .endm
 """
 
-    labels_inc = f"""\
-{func_macros}
-{jlabel_macro_labelsinc}
-{data_macros}
-{nm_macros}\
-"""
     macros_inc = f"""\
 {func_macros}
 {jlabel_macro_macroinc}
@@ -186,7 +189,18 @@ def write_assembly_inc_files():
     if options.opts.compiler.uses_include_asm:
         # File used by original assembler
         preamble = "# This file is used by the original compiler/assembler.\n# Defines the expected assembly macros.\n"
-        _write("include/labels.inc", f"{preamble}\n{labels_inc}")
+
+        if options.opts.platform == "psx":
+            preamble += '\n.include "gte_macros.inc"\n'
+
+        labels_inc = f"""\
+{preamble}
+{func_macros}
+{jlabel_macro_labelsinc}
+{data_macros}
+{nm_macros}\
+"""
+        _write("include/labels.inc", labels_inc)
 
     if options.opts.platform in {"n64", "psx"}:
         gas = macros_inc
@@ -275,7 +289,7 @@ def write_assembly_inc_files():
 .set $fs5f,         $f31
 """
     elif options.opts.platform == "psx":
-        gas += '\ninclude "gte_macros.inc"\n'
+        gas += '\n.include "gte_macros.inc"\n'
         write_gte_macros()
 
     if options.opts.generated_macro_inc_content is not None:
@@ -285,6 +299,15 @@ def write_assembly_inc_files():
     preamble = (
         "# This file is used by modern gas.\n# Defines the expected assembly macros\n"
     )
+    gas = f"""\
+# Evaluate this file only once in case it's included more than once
+.ifndef _MACRO_INC_GUARD
+.internal _MACRO_INC_GUARD
+.set _MACRO_INC_GUARD, 1
+
+{gas}
+.endif
+"""
     _write("include/macro.inc", f"{preamble}\n{gas}")
 
 

{splat64-0.35.0 → splat64-0.35.2}/test/basic_app/expected/include/labels.inc

@@ -31,7 +31,8 @@
 
 
 # A label referenced by a jumptable.
-.macro jlabel label, visibility=global
+.macro jlabel label, visibility=local
+    .\visibility \label
     \label:
 .endm
 

{splat64-0.35.0 → splat64-0.35.2}/test/basic_app/expected/include/macro.inc

@@ -1,6 +1,11 @@
 # This file is used by modern gas.
 # Defines the expected assembly macros
 
+# Evaluate this file only once in case it's included more than once
+.ifndef _MACRO_INC_GUARD
+.internal _MACRO_INC_GUARD
+.set _MACRO_INC_GUARD, 1
+
 # A function symbol.
 .macro glabel label, visibility=global
     .\visibility \label
@@ -33,7 +38,6 @@
 # A label referenced by a jumptable.
 .macro jlabel label, visibility=global
     .\visibility \label
-    .type \label, @function
     \label:
 .endm
 
@@ -128,3 +132,5 @@
 .set $fs4f,         $f29
 .set $fs5,          $f30
 .set $fs5f,         $f31
+
+.endif