Remove include_macro_inc option (#395)

* Remove include_macro_inc

* fix test

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Fixed the `subalign` segment property logic to be more straightforward
 * Updated required versions of rabbitizier, n64img, and crunch64
+* Removed `include_macro_inc` option, as it was never required and often detrimental
 
 ### 0.25.3
 

docs/Configuration.md

@@ -556,10 +556,6 @@ Defaults to `ehlabel`
 
 Toggles the .size directive emitted by the disassembler
 
-### include_macro_inc
-
-Determines including the macro.inc file on non-migrated rodata variables
-
 ### mnemonic_ljust
 
 Determines the number of characters to left align before the instruction

src/splat/segtypes/common/c.py

@@ -340,8 +340,6 @@ def create_unmigrated_rodata_file(
         outpath.parent.mkdir(parents=True, exist_ok=True)
 
         with outpath.open("w", newline="\n") as f:
-            if options.opts.include_macro_inc:
-                f.write('.include "macro.inc"\n\n')
             preamble = options.opts.generated_s_preamble
             if preamble:
                 f.write(preamble + "\n")

src/splat/util/compiler.py

@@ -13,7 +13,6 @@ class Compiler:
     asm_ehtable_label_macro: str = "ehlabel"
     c_newline: str = "\n"
     asm_inc_header: str = ""
-    include_macro_inc: bool = True
     asm_emit_size_directive: Optional[bool] = None
 
 
@@ -29,11 +28,10 @@ class Compiler:
     asm_data_macro=".globl",
     asm_end_label=".end",
     c_newline="\r\n",
-    include_macro_inc=False,
     asm_emit_size_directive=False,
 )
 
-IDO = Compiler("IDO", include_macro_inc=False, asm_emit_size_directive=False)
+IDO = Compiler("IDO", asm_emit_size_directive=False)
 
 EEGCC = Compiler("EEGCC")
 

src/splat/util/options.py

@@ -187,8 +187,6 @@ class SplatOpts:
     asm_ehtable_label_macro: str
     # Toggles the .size directive emitted by the disassembler
     asm_emit_size_directive: Optional[bool]
-    # Determines including the macro.inc file on non-migrated rodata variables
-    include_macro_inc: bool
     # Determines the number of characters to left align before the TODO finish documenting
     mnemonic_ljust: int
     # Determines whether to pad the rom address
@@ -507,9 +505,6 @@ def parse_endianness() -> Literal["big", "little"]:
             "asm_ehtable_label_macro", str, comp.asm_ehtable_label_macro
         ),
         asm_emit_size_directive=asm_emit_size_directive,
-        include_macro_inc=p.parse_opt(
-            "include_macro_inc", bool, comp.include_macro_inc
-        ),
         mnemonic_ljust=p.parse_opt("mnemonic_ljust", int, 11),
         rom_address_padding=p.parse_opt("rom_address_padding", bool, False),
         mips_abi_gpr=p.parse_opt_within(

test/basic_app/expected/asm/nonmatchings/main/D_80000510.s

@@ -1,5 +1,3 @@
-.include "macro.inc"
-
 .section .rodata
 
 glabel D_80000510