tools/ contains what's needed to build the ROMs; utils/ contains disassembly utilites

31 files changed, 65 insertions, 262 deletions

diff --git a/Makefile b/Makefile
index d45f7f8..af781be 100644
--- a/Makefile
+++ b/Makefile
@@ -1,30 +1,35 @@
+ROM := pokegold-spaceworld.gb
+CORRECTEDROM := $(ROM:%.gb=%-correctheader.gb)
+BASEROM := baserom.gb
+
+DIRS := home engine data audio maps
+FILES := bin.asm gfx.asm vram.asm sram.asm wram.asm hram.asm
+
 BUILD := build
 
+rwildcard = $(foreach d, $(wildcard $1*), $(filter $(subst *, %, $2), $d) $(call rwildcard, $d/, $2))
+ASMFILES := $(call rwildcard, $(DIRS), *.asm) $(FILES)
+OBJS := $(patsubst %.asm, $(BUILD)/%.o, $(ASMFILES))
+OBJS += $(BUILD)/shim.o
+
+
+### Build tools
+
 MD5 := md5sum -c
-PYTHON := python
-PYTHON3 := python3
+PYTHON := python3
 
 RGBDS ?=
-RGBASM := $(RGBDS)rgbasm
-RGBGFX := $(RGBDS)rgbgfx
-RGBLINK := $(RGBDS)rgblink
-RGBFIX := $(RGBDS)rgbfix
-sort_sym := tools/sort_symfile.sh
+RGBASM  ?= $(RGBDS)rgbasm
+RGBFIX  ?= $(RGBDS)rgbfix
+RGBGFX  ?= $(RGBDS)rgbgfx
+RGBLINK ?= $(RGBDS)rgblink
 
 RGBASMFLAGS := -h -E -i $(BUILD)/ -DGOLD -DDEBUG=1
+
 tools/gfx :=
 
-ROM := pokegold-spaceworld.gb
-LINKERSCRIPT := pokegold-spaceworld-gen.link
-BASEROM := baserom.gb
-SHIM := shim.sym
-CORRECTEDROM := $(ROM:%.gb=%-correctheader.gb)
 
-rwildcard = $(foreach d, $(wildcard $1*), $(filter $(subst *, %, $2), $d) $(call rwildcard, $d/, $2))
-DIRS := home engine data audio maps
-ASMFILES := $(call rwildcard, $(DIRS), *.asm) bin.asm gfx.asm vram.asm sram.asm wram.asm hram.asm
-OBJS := $(patsubst %.asm, $(BUILD)/%.o, $(ASMFILES))
-OBJS += $(BUILD)/shim.o
+### Build targets
 
 .SECONDEXPANSION:
 
@@ -45,22 +50,16 @@ clean:
 	rm -rf $(ROM) $(CORRECTEDROM) $(BUILD) $(ROMS:.gb=.sym) $(ROMS:.gb=.map) *.d
 	"$(MAKE)" -C tools clean
 
-# Remove files except for graphics.
-.PHONY: mostlyclean
-mostlyclean:
+# Remove generated files except for graphics.
+.PHONY: tidy
+tidy:
 	rm -rf $(ROM) $(CORRECTEDROM) $(OBJS) $(ROMS:.gb=.sym) $(ROMS:.gb=.map) *.d
 
-# Utilities
+# Visualize disassembly progress.
 .PHONY: coverage
 coverage: $(ROM:.gb=.map) tools/disasm_coverage.py
 	$(PYTHON) tools/disasm_coverage.py -m $< -b 0x40
 
-.PHONY: linkerscript
-linkerscript: $(ROM:.gb=-gen.link)
-
-# TODO FIX HARDCODE
-%.link: pokegold-spaceworld.map tools/map2link.py
-	$(PYTHON3) tools/map2link.py $< $@
 
 %.map: %.gb
 
@@ -70,22 +69,25 @@ $(CORRECTEDROM): %-correctheader.gb: %.gb
 	$(RGBFIX) -f hg -m 0x10 $@
 
 $(ROM): poke%-spaceworld.gb: $(OBJS) | $(BASEROM)
-	$(RGBLINK) -d -n $(@:.gb=.sym) -m $(@:.gb=.map) -l $(@:.gb=.link) -O $(BASEROM) -o $@ $^
+	$(RGBLINK) -d -n $(@:.gb=.sym) -m $(@:.gb=.map) -l layout.link -O $(BASEROM) -o $@ $^
 	$(RGBFIX) -f lh -k 01 -l 0x33 -m 0x03 -p 0 -r 3 -t "POKEMON2$(shell echo $* | cut -d _ -f 1 | tr '[:lower:]' '[:upper:]')" $@
-	$(sort_sym) $(@:.gb=.sym)
 
 $(BASEROM):
 	@echo "Please obtain a copy of Gold_debug.sgb and put it in this directory as $@"
 	@exit 1
 
-$(BUILD)/shim.asm: tools/make_shim.py $(SHIM) | $$(dir $$@)
-	$(PYTHON3) tools/make_shim.py -w $(filter-out $<, $^) > $@
+$(BUILD)/shim.asm: tools/make_shim.py shim.sym | $$(dir $$@)
+	$(PYTHON) tools/make_shim.py -w $(filter-out $<, $^) > $@
 
 $(BUILD)/%.o: $(BUILD)/%.asm | $$(dir $$@)
 	$(RGBASM) $(RGBASMFLAGS) $(OUTPUT_OPTION) $<
+
 $(BUILD)/%.o: %.asm | $$(dir $$@)
 	$(RGBASM) $(RGBASMFLAGS) $(OUTPUT_OPTION) $<
 
+
+### Misc file-specific graphics rules
+
 $(BUILD)/gfx/sgb/sgb_border_alt.2bpp: tools/gfx += --trim-whitespace
 $(BUILD)/gfx/sgb/sgb_border_gold.2bpp: tools/gfx += --trim-whitespace
 $(BUILD)/gfx/sgb/sgb_border_gold_corrupted.2bpp: tools/gfx += --trim-whitespace
@@ -94,14 +96,22 @@ $(BUILD)/gfx/sgb/corrupted_9e1c.2bpp: tools/gfx += --trim-whitespace
 $(BUILD)/gfx/sgb/corrupted_a66c.2bpp: tools/gfx += --trim-whitespace
 $(BUILD)/gfx/sgb/corrupted_b1e3.2bpp: tools/gfx += --trim-whitespace
 $(BUILD)/gfx/sgb/sgb_border_silver.2bpp: tools/gfx += --trim-whitespace
+
 $(BUILD)/gfx/trainer_card/leaders.2bpp: tools/gfx += --trim-whitespace
+
 $(BUILD)/gfx/pokegear/town_map.2bpp: tools/gfx += --trim-trailing
+
 $(BUILD)/gfx/minigames/slots.2bpp: tools/gfx += --trim-whitespace
 $(BUILD)/gfx/minigames/poker.2bpp: tools/gfx += --trim-whitespace
+
 $(BUILD)/gfx/intro/purin_pikachu.2bpp: tools/gfx += --trim-whitespace
+
 $(BUILD)/gfx/battle_anims/attack_animations_1.2bpp: tools/gfx += --trim-whitespace
 $(BUILD)/gfx/battle_anims/attack_animations_2.2bpp: tools/gfx += --trim-whitespace
 
+
+### Catch-all graphics rules
+
 .PRECIOUS: $(BUILD)/%.pic
 $(BUILD)/%.pic: $(BUILD)/%.2bpp tools/pkmncompress | $$(dir $$@)
 	tools/pkmncompress $< $@
@@ -124,7 +134,10 @@ $(BUILD)/%.tilemap: %.png | $$(dir $$@)
 %/:
 	mkdir -p $@
 
-DEPENDENCY_SCAN_EXIT_STATUS := $(shell $(PYTHON3) tools/scan_includes.py $(BUILD:%=-b %) $(ASMFILES) > dependencies.d; echo $$?)
+
+### Scan .asm files for INCLUDE/INCBIN dependencies
+
+DEPENDENCY_SCAN_EXIT_STATUS := $(shell $(PYTHON) tools/scan_includes.py $(BUILD:%=-b %) $(ASMFILES) > dependencies.d; echo $$?)
 ifneq ($(DEPENDENCY_SCAN_EXIT_STATUS), 0)
 $(error Dependency scan failed)
 endif
diff --git a/gfx.py b/gfx.py
index cda03b0..04e9f7c 100644
--- a/gfx.py
+++ b/gfx.py
@@ -5,7 +5,7 @@
 import os
 import argparse
 
-from tools import gfx, lz
+from utils import gfx, lz
 
 
 # Graphics with inverted tilemaps that aren't covered by filepath_rules.
diff --git a/pokegold-spaceworld.link b/layout.link
index c3795e0..c3795e0 100644
--- a/pokegold-spaceworld.link
+++ b/layout.link
diff --git a/tools/disasm_coverage.py b/tools/disasm_coverage.py
index 9fcd61e..fcb9e86 100644
--- a/tools/disasm_coverage.py
+++ b/tools/disasm_coverage.py
@@ -1,5 +1,5 @@
-# #!/usr/bin/env python3
-# coding: utf-8
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
 
 from __future__ import division
 
diff --git a/tools/fix_sections.py b/tools/fix_sections.py
deleted file mode 100644
index dc23f52..0000000
--- a/tools/fix_sections.py
+++ /dev/null
@@ -1,137 +0,0 @@
-import os, errno
-import re
-import fix_sections_directory
-
-os.chdir("..")
-cwd = os.getcwd()
-
-debug_lines_startswith = [
-    "SECTION ",
-    "else",
-    "SECTION ",
-    "endc"
-]
-
-with open("pokegold-spaceworld-gen.link", "r") as f:
-    linkerscript = f.read()
-
-def clean_section(line, file, multiple):
-    global linkerscript
-    lines = line.lstrip().split("\"")
-    if "@" in lines[1] or file == lines[1] or file == "hram.asm" or file == "vram.asm" or file == "sram.asm":
-        file = lines[1]
-    else:
-        file += ("@" + lines[1]) if multiple else ""
-    
-    linkerscript = linkerscript.replace("\"" + lines[1] + "\"", "\"" + file + "\"")
-    if "ROMX" in lines[2]:
-        return "SECTION \"%s\", ROMX" % file
-    elif "HRAM" in lines[2]:
-        return "SECTION \"%s\", HRAM" % file
-    elif "VRAM" in lines[2]:
-        return "SECTION \"%s\", VRAM" % file
-    elif "ROM0" in lines[2]:
-        return "SECTION \"%s\", ROM0" % file
-    elif "SRAM" in lines[2]:
-        return "SECTION \"%s\", SRAM" % file
-    else:
-        raise
-
-TEMP_PATH = fix_sections_directory.TEMP_DIRECTORY
-
-for root, dirs, files in os.walk(cwd):
-    for file in files:
-        rel_root = os.path.relpath(root, cwd)
-        if not rel_root.startswith("build") and not rel_root.startswith("temp") and file.endswith(".asm") and file != "rst.asm" and file != "wram.asm" and file != "zero_checksum.asm":
-            canonical_path = os.path.join(root, file)
-            rel_path = os.path.relpath(canonical_path, cwd)
-            with open(canonical_path, "r") as f:
-                contents = f.read()
-            content_lines = contents.splitlines()
-            
-            if "SECTION" in contents:
-                print(canonical_path)
-                modify_flag = False
-                skip_next_line = False
-                for i, line in enumerate(content_lines):
-                    if not skip_next_line:
-                        if line.lstrip().startswith("SECTION"):
-                            modify_flag = True
-                            content_lines[i] = clean_section(content_lines[i], rel_path, contents.count("SECTION") > 1)
-                        elif "if DEBUG" in line:
-                            debug_content_lines = content_lines[i+1:i+5]
-                            debug_code = False
-                            for debug_content_line, debug_line_startswith in zip(debug_content_lines, debug_lines_startswith):
-                                if not debug_content_line.lstrip().startswith(debug_line_startswith):
-                                    break
-                            else:
-                                modify_flag = True
-                                content_lines[i] = "; " + content_lines[i]
-                                content_lines[i+1] = clean_section(content_lines[i+1], rel_path, contents.count("SECTION") > 2)
-                                content_lines[i+2] = "; " + content_lines[i+2]
-                                content_lines[i+3] = "; " + content_lines[i+3]
-                                content_lines[i+4] = "; " + content_lines[i+4]
-                                skip_next_line = True
-                    else:
-                        skip_next_line = False
-                
-                if modify_flag:
-                    output = "\n".join(content_lines)
-                    print("rel root: " + rel_root)
-                    try:
-                        os.makedirs(TEMP_PATH + rel_root)
-                    except OSError as e:
-                        if e.errno != errno.EEXIST:
-                            raise
-                    
-                    with open(TEMP_PATH + rel_path, "w+") as f:
-                        f.write(output)
-
-linkerscript_lines = linkerscript.splitlines()
-
-i = 0
-clean_wram = False
-
-while i < len(linkerscript_lines):
-    line = linkerscript_lines[i]
-    if clean_wram:
-        if "org $dfff" not in line:
-            print(linkerscript_lines.pop(i))
-        else:
-            clean_wram = False
-            i += 1
-    elif "\"Shim for " in line:
-        no_pop_count = 0
-        shim_addr = line.replace(", ", " ; ").split(" ; ")[1]
-        if linkerscript_lines[i-1] == "\torg " + shim_addr and linkerscript_lines[i-1] != "\torg $4000":
-            print(linkerscript_lines.pop(i-1))
-        else:
-            no_pop_count += 1
-        print(linkerscript_lines.pop(i-1 + no_pop_count))
-        
-        if linkerscript_lines[i-1 + no_pop_count] == "\t; " + shim_addr:
-            print(linkerscript_lines.pop(i-1 + no_pop_count))
-        else:
-            no_pop_count += 1
-        
-        i -= 3 - no_pop_count
-        print("")
-    elif "ROMX" in line and "org $4000" not in linkerscript_lines[i+1]:
-        linkerscript_lines.insert(i+1, "\torg $4000")
-        i += 1
-    elif line.startswith("WRAM0"):
-        linkerscript_lines.insert(i+1, "\torg $c000")
-        i += 1
-    elif "\"Map Buffer\"" in line:
-        clean_wram = True
-        i += 1
-    else:
-        i += 1
-
-for i in range(len(linkerscript_lines)):
-    linkerscript_lines[i] = linkerscript_lines[i].split(" ; ")[0]
-
-linkerscript = "\n".join(linkerscript_lines) + "\n"
-
-with open(TEMP_PATH + "pokegold-spaceworld.link", "w+") as f:
-    f.write(linkerscript)
\ No newline at end of file
diff --git a/tools/fix_sections_directory.py b/tools/fix_sections_directory.py
deleted file mode 100644
index d359c8c..0000000
--- a/tools/fix_sections_directory.py
+++ /dev/null
@@ -1 +0,0 @@
-TEMP_DIRECTORY = ""
\ No newline at end of file
diff --git a/tools/make_shim.py b/tools/make_shim.py
index e2e4bf2..e88e3fc 100644
--- a/tools/make_shim.py
+++ b/tools/make_shim.py
@@ -1,4 +1,5 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
 
 from __future__ import print_function
 import argparse
diff --git a/tools/mapreader.py b/tools/mapreader.py
index 41ad935..95a4723 100644
--- a/tools/mapreader.py
+++ b/tools/mapreader.py
@@ -1,5 +1,5 @@
-# #!/usr/bin/env python3
-# coding: utf-8
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
 
 import re
 
@@ -168,4 +168,4 @@ class MapReader:
             else:
                 v['sections'].sort(key=lambda x: x['beg'])
                 for vv in v['sections']:
-                        vv['symbols'].sort(key=lambda x: x['address'])
\ No newline at end of file
+                        vv['symbols'].sort(key=lambda x: x['address'])
diff --git a/tools/scan_includes.py b/tools/scan_includes.py
index 34e1f09..c30adc0 100644
--- a/tools/scan_includes.py
+++ b/tools/scan_includes.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 """Get all the dependencies of RGBDS assembly files recursively,
diff --git a/tools/sort_sym.py b/tools/sort_sym.py
deleted file mode 100644
index f4674e8..0000000
--- a/tools/sort_sym.py
+++ /dev/null
@@ -1,68 +0,0 @@
-#!/usr/bin/python3.6
-
-import argparse
-from functools import total_ordering
-
-
-@total_ordering
-class GBSection:
-    ROM0 = 0
-    ROMX = 1
-    VRAM = 2
-    SRAM = 3
-    WRAM0 = 4
-    WRAMX = 5
-
-    __thresholds__ = (0x4000, 0x8000, 0xa000, 0xc000, 0xd000, 0xe000)
-
-    def __init__(self, addr):
-        self.ident = sum(x <= addr for x in self.__thresholds__)
-
-    @property
-    def start(self):
-        if self.ident == self.ROM0:
-            return 0
-        return self.__thresholds__[self.ident - 1]
-
-    @property
-    def end(self):
-        return self.__thresholds__[self.ident]
-
-    def __eq__(self, other):
-        return self.ident == other.ident
-
-    def __lt__(self, other):
-        return self.ident < other.ident
-
-
-def read_sym(filename):
-    with open(filename) as fp:
-        for line in fp:
-            try:
-                line, *rest = line.split(';')
-                pointer, name = line.split()
-                bank, addr = (int(part, 16) for part in pointer.split(':'))
-                yield bank, addr, name
-            except ValueError:
-                continue
-
-
-def sort_key(args):
-    bank, addr, name = args
-    return GBSection(addr), bank, addr, name
-
-
-def main():
-    parser = argparse.ArgumentParser()
-    parser.add_argument('symfile')
-    args = parser.parse_args()
-
-    symbols = list(read_sym(args.symfile))
-    symbols.sort(key=sort_key)
-    with open(args.symfile, 'w') as fp:
-        for bank, addr, name in symbols:
-            print(f'{bank:02X}:{addr:04X}', name, file=fp)
-
-
-if __name__ == '__main__':
-    main()
diff --git a/tools/sort_symfile.sh b/tools/sort_symfile.sh
deleted file mode 100755
index 82fced5..0000000
--- a/tools/sort_symfile.sh
+++ /dev/null
@@ -1,12 +0,0 @@
-#!/bin/sh
-sed \
-    -e "s/^..:[0-3]/0_ROM0@&/g" \
-    -e "s/^..:[4-7]/1_ROMX@&/g" \
-    -e "s/^..:[8-9]/2_VRAM@&/g" \
-    -e "s/^..:[A-B]/3_SRAM@&/g" \
-    -e "s/^00:[C-D]/4_WRAM0@&/g" \
-    -e "s/^..:[D-D]/5_WRAMX@&/g" \
-    $1 \
-| sort -o $1
-TEMP_FILE=$(mktemp)
-sed -e "s/^.*@//g" $1 > $TEMP_FILE && mv $TEMP_FILE $1
diff --git a/tools/__init__.py b/utils/__init__.py
index b64ec3b..b64ec3b 100644
--- a/tools/__init__.py
+++ b/utils/__init__.py
diff --git a/compare.sh b/utils/compare.sh
index b52696d..44e0771 100644
--- a/compare.sh
+++ b/utils/compare.sh
@@ -8,4 +8,4 @@ fi
 
 hexdump -C pokegold-spaceworld.gb > pokegold-spaceworld.txt
 
-diff -u baserom.txt pokegold-spaceworld.txt | less
\ No newline at end of file
+diff -u baserom.txt pokegold-spaceworld.txt | less
diff --git a/tools/dump_names.py b/utils/dump_names.py
index 81f357a..12eafb5 100644
--- a/tools/dump_names.py
+++ b/utils/dump_names.py
@@ -1,4 +1,5 @@
-#!/usr/bin/env python
+#!/usr/bin/env python2
+# -*- coding: utf-8 -*-
 
 import sys, os, io
 from read_charmap import read_charmap
diff --git a/tools/dump_text.py b/utils/dump_text.py
index 808f674..c36298e 100644
--- a/tools/dump_text.py
+++ b/utils/dump_text.py
@@ -1,4 +1,5 @@
-#!/usr/bin/python3
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
 
 import argparse
 import sys
diff --git a/tools/gfx.py b/utils/gfx.py
index 3ccafe0..80c84d3 100644
--- a/tools/gfx.py
+++ b/utils/gfx.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python2
 # -*- coding: utf-8 -*-
 
 import os
diff --git a/tools/lz.py b/utils/lz.py
index aef5c64..aef5c64 100644
--- a/tools/lz.py
+++ b/utils/lz.py
diff --git a/tools/map2link.py b/utils/map2link.py
index f1cd3a3..2c7d40c 100644
--- a/tools/map2link.py
+++ b/utils/map2link.py
@@ -1,4 +1,5 @@
-#!/bin/python3.6
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
 
 import argparse
 import re
diff --git a/tools/png.py b/utils/png.py
index db6da12..db6da12 100644
--- a/tools/png.py
+++ b/utils/png.py
diff --git a/tools/read_charmap.py b/utils/read_charmap.py
index af290c3..77036f6 100644
--- a/tools/read_charmap.py
+++ b/utils/read_charmap.py
@@ -1,3 +1,6 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
 import os, io
 from re import compile
 from sys import stderr
diff --git a/tools/tests/README.txt b/utils/tests/README.txt
index 750482e..750482e 100644
--- a/tools/tests/README.txt
+++ b/utils/tests/README.txt
diff --git a/tools/tests/charmap.asm b/utils/tests/charmap.asm
index 70e228c..70e228c 100644
--- a/tools/tests/charmap.asm
+++ b/utils/tests/charmap.asm
diff --git a/tools/tests/dump_test.cc.txt b/utils/tests/dump_test.cc.txt
index 4dfd14a..4dfd14a 100644
--- a/tools/tests/dump_test.cc.txt
+++ b/utils/tests/dump_test.cc.txt
diff --git a/tools/tests/dump_test.cc_endless.txt b/utils/tests/dump_test.cc_endless.txt
index 5c59830..5c59830 100644
--- a/tools/tests/dump_test.cc_endless.txt
+++ b/utils/tests/dump_test.cc_endless.txt
diff --git a/tools/tests/dump_test.cc_tc.txt b/utils/tests/dump_test.cc_tc.txt
index e49a010..e49a010 100644
--- a/tools/tests/dump_test.cc_tc.txt
+++ b/utils/tests/dump_test.cc_tc.txt
diff --git a/tools/tests/dump_test.cc_tc_endless.txt b/utils/tests/dump_test.cc_tc_endless.txt
index dbf8e8b..dbf8e8b 100644
--- a/tools/tests/dump_test.cc_tc_endless.txt
+++ b/utils/tests/dump_test.cc_tc_endless.txt
diff --git a/tools/tests/dump_test.endless.txt b/utils/tests/dump_test.endless.txt
index fbbdeef..fbbdeef 100644
--- a/tools/tests/dump_test.endless.txt
+++ b/utils/tests/dump_test.endless.txt
diff --git a/tools/tests/dump_test.tc.txt b/utils/tests/dump_test.tc.txt
index 82c276d..82c276d 100644
--- a/tools/tests/dump_test.tc.txt
+++ b/utils/tests/dump_test.tc.txt
diff --git a/tools/tests/dump_test.tc_endless.txt b/utils/tests/dump_test.tc_endless.txt
index 37bdda0..37bdda0 100644
--- a/tools/tests/dump_test.tc_endless.txt
+++ b/utils/tests/dump_test.tc_endless.txt
diff --git a/tools/tests/dump_test.txt b/utils/tests/dump_test.txt
index a181744..a181744 100644
--- a/tools/tests/dump_test.txt
+++ b/utils/tests/dump_test.txt
diff --git a/tools/tests/dump_text_test.bin b/utils/tests/dump_text_test.bin
index 778a446..778a446 100644
--- a/tools/tests/dump_text_test.bin
+++ b/utils/tests/dump_text_test.bin