g/j1: Cleanup all main issues in the formatter and format all of goal_src/jak1 (#3535)

This PR does two main things:
1. Work through the main low-hanging fruit issues in the formatter
keeping it from feeling mature and usable
2. Iterate and prove that point by formatting all of the Jak 1 code
base. **This has removed around 100K lines in total.**
- The decompiler will now format it's results for jak 1 to keep things
from drifting back to where they were. This is controlled by a new
config flag `format_code`.

How am I confident this hasn't broken anything?:
- I compiled the entire project and stored it's `out/jak1/obj` files
separately
- I then recompiled the project after formatting and wrote a script that
md5's each file and compares it (`compare-compilation-outputs.py`
- The results (eventually) were the same:

![Screenshot 2024-05-25
132900](https://github.com/open-goal/jak-project/assets/13153231/015e6f20-8d19-49b7-9951-97fa88ddc6c2)
> This proves that the only difference before and after is non-critical
whitespace for all code/macros that is actually in use.

I'm still aware of improvements that could be made to the formatter, as
well as general optimization of it's performance. But in general these
are for rare or non-critical situations in my opinion and I'll work
through them before doing Jak 2. The vast majority looks great and is
working properly at this point. Those known issues are the following if
you are curious:

![image](https://github.com/open-goal/jak-project/assets/13153231/0edfaba1-6d36-40f5-ab23-0642209867c4)

scripts/gsrc/compare-compilation-outputs.py

@@ -0,0 +1,53 @@
+# Simple script that compares every file in `out/game/obj` with a base directory
+# This is useful for when you expect your compilation output to be identical, ie. when you've just made formatting only changes
+# If every file matches...you should be able to be confident that you have broken nothing!
+
+import os
+import hashlib
+
+def hash_file(filepath):
+    """Returns the MD5 hash of the file."""
+    hasher = hashlib.md5()
+    with open(filepath, 'rb') as f:
+        buf = f.read()
+        hasher.update(buf)
+    return hasher.hexdigest()
+
+def compare_directories(base_dir, compare_dir):
+    """Compares files in two directories based on their MD5 hash."""
+    mismatched_files = []
+    missing_files = []
+
+    # Iterate through files in the base directory
+    for root, _, files in os.walk(base_dir):
+        for file in files:
+            base_file_path = os.path.join(root, file)
+            relative_path = os.path.relpath(base_file_path, base_dir)
+            compare_file_path = os.path.join(compare_dir, relative_path)
+
+            if os.path.exists(compare_file_path):
+                base_file_hash = hash_file(base_file_path)
+                compare_file_hash = hash_file(compare_file_path)
+                if base_file_hash != compare_file_hash:
+                    mismatched_files.append(relative_path)
+            else:
+                missing_files.append(relative_path)
+
+    # Report results
+    if not mismatched_files and not missing_files:
+        print("All files matched successfully.")
+    else:
+        if mismatched_files:
+            print("Mismatched files:")
+            for file in mismatched_files:
+                print(f" - {file}")
+        if missing_files:
+            print("Missing files:")
+            for file in missing_files:
+                print(f" - {file}")
+
+# Usage example
+base_directory = './out/jak1/obj'
+compare_directory = './out/jak1/obj_master'
+print(f'Comparing {base_directory} with {compare_directory}')
+compare_directories(base_directory, compare_directory)

scripts/gsrc/format-gsrc-file.py

@@ -0,0 +1,65 @@
+# import glob
+# import json
+# import os
+# files = glob.glob("./goal_src/jak1/**/*.gc", recursive=True)
+# json_data = []
+# for file in files:
+#     json_data.append({'path': os.path.abspath(file), 'status': 'not-formatted'})
+
+# with open("./scripts/gsrc/format-jak1.json", "w") as f:
+#     f.write(json.dumps(json_data, indent=2))
+
+import json
+import math
+import subprocess
+from colorama import just_fix_windows_console, Fore, Back, Style
+
+just_fix_windows_console()
+
+def format_the_file(apply_status):
+    with open("./scripts/gsrc/format-jak1.json", "r") as f:
+        formatting_progress = json.load(f)
+
+    # find the next file
+    curr_file = None
+    go_to_next = False
+    open_file_in_vscode = False
+    if apply_status == "next":
+        go_to_next = True
+        open_file_in_vscode = True
+
+    for index, file in enumerate(formatting_progress):
+        if file['status'] == 'not-formatted':
+            if go_to_next:
+                print(f"Marking {file['path']} as formatted")
+                print(f"{Fore.GREEN} {(index / len(formatting_progress)) * 100:.3f}% {Fore.RESET} Completed")
+                formatting_progress[index]['status'] = 'formatted'
+                go_to_next = False
+            else:
+                curr_file = file['path']
+                if open_file_in_vscode:
+                    subprocess.run(["C:\\Users\\xtvas\\AppData\\Local\\Programs\\Microsoft VS Code\\bin\\code.cmd", file['path']]) 
+                break
+
+    # format it
+    print(f"Formatting {curr_file}")
+    subprocess.run(["./out/build/Debug/bin/formatter", "--write", "--file", curr_file]) 
+
+    # save status
+    if apply_status is not None and (apply_status == "skip" or apply_status == "next"):
+        # TODO - add skip support back if i ever want to use it
+        with open("./scripts/gsrc/format-jak1.json", "w") as f:
+            f.write(json.dumps(formatting_progress, indent=2))
+
+    subprocess.run(["git", "diff", "--shortstat", "origin/master"])
+
+def main():
+    while True:
+        user_input = input(Fore.CYAN + "Type 'n' to proceed to the next file or just hit enter to re-format the current file: " + Fore.RESET)
+        if user_input == 'n':
+            format_the_file("next")
+        else:
+            format_the_file(None)
+
+if __name__ == "__main__":
+    main()

scripts/gsrc/format-gsrc-folder.py

@@ -0,0 +1,20 @@
+import glob
+from pathlib import Path
+import subprocess
+import time
+from colorama import just_fix_windows_console, Fore, Back, Style
+
+just_fix_windows_console()
+
+files = glob.glob("./goal_src/jak1/**/*.gc", recursive=True)
+total_ms = 0
+for file in files:
+    start_time = time.perf_counter()
+    subprocess.run(["./out/build/Release/bin/formatter", "--write", "--file", file])
+    elapsed_ms = (time.perf_counter() - start_time) * 1000
+    total_ms = total_ms + elapsed_ms
+    print(f"Formatted .../{Path(file).stem} in {Fore.CYAN} {elapsed_ms:.2f}ms {Fore.RESET}")
+
+print(f"In total that took {total_ms}ms for {len(files)} files!")
+
+subprocess.run(["git", "diff", "--shortstat", "origin/master"])