From 80f7504f495134dd346b13bae9aa732968365db1 Mon Sep 17 00:00:00 2001
From: Rangi <remy.oukaour+rangi42@gmail.com>
Date: Wed, 14 Oct 2020 11:22:34 -0400
Subject: [PATCH] tools/sym_comments.py can comment labels with their sym file
 addresses

---
 tools/sym_comments.py | 49 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 tools/sym_comments.py

diff --git a/tools/sym_comments.py b/tools/sym_comments.py
new file mode 100644
index 000000000..b26a81b7f
--- /dev/null
+++ b/tools/sym_comments.py
@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+Usage: ./sym_comments.py file.asm [pokecrystal.sym] > file_commented.asm
+
+Comments each label in file.asm with its bank:address from the sym file.
+"""
+
+import sys
+import re
+
+if len(sys.argv) != 2 and len(sys.argv) != 3:
+	print('Usage: %s file.asm [pokecrystal.sym] > file_commented.asm' % sys.argv[0], file=sys.stderr)
+
+wram_name = sys.argv[1]
+sym_name = sys.argv[2] if len(sys.argv) == 3 else 'pokecrystal.sym'
+
+sym_format = r'[A-Za-z_][A-Za-z0-9_#@]*'
+sym_def_rx = re.compile(r'(^%s)(:.*)|(^\.%s)(.*)' % (sym_format, sym_format))
+
+sym_addrs = {}
+with open(sym_name, 'r', encoding='utf-8') as f:
+	for line in f:
+		line = line.split(';', 1)[0].rstrip()
+		parts = line.split(' ', 1)
+		if len(parts) != 2:
+			continue
+		addr, sym = parts
+		sym_addrs[sym] = addr
+
+with open(wram_name, 'r', encoding='utf-8') as f:
+	cur_label = None
+	for line in f:
+		line = line.rstrip()
+		m = re.match(sym_def_rx, line)
+		if m:
+			sym, rest = m.group(1), m.group(2)
+			if sym is None and rest is None:
+				sym, rest = m.group(3), m.group(4)
+			key = sym
+			if not sym.startswith('.'):
+				cur_label = sym
+			elif cur_label:
+				key = cur_label + sym
+			if key in sym_addrs:
+				addr = sym_addrs[key]
+				line = sym + rest + ' ; ' + addr
+		print(line)