mirror of
https://github.com/open-goal/jak-project.git
synced 2024-10-20 11:26:18 -04:00
c162c66118
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:  > 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: 
54 lines
2 KiB
Python
54 lines
2 KiB
Python
# 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)
|