scripts: update gsrc files with modifications using git merge (#2164)

scripts/gsrc/check-for-conflicts.py

@@ -0,0 +1,25 @@
+# Merge tools use specific algorithms or assumptions to detect conflicts
+# and not all of them will obviously flag them, even if they use the standard format
+#
+# So this is to ensure no conflict markers get ignored in goal_src atleast
+import os
+
+files_with_unresolved_conflicts = []
+
+for dirpath, subdirs, files in os.walk("./goal_src"):
+  for filename in files:
+    # Get the file contents
+    with open(os.path.join(dirpath, filename), "r") as f:
+      lines = f.readlines()
+      for line in lines:
+        if "<<<<<<<" in line:
+          files_with_unresolved_conflicts.append(os.path.join(dirpath, filename))
+          break
+
+if len(files_with_unresolved_conflicts) == 0:
+  exit(0)
+
+print("There are unresolved conflicts in ./goal_src/")
+for file in files_with_unresolved_conflicts:
+  print(file)
+exit(1)

scripts/gsrc/update-from-decomp.py

@@ -36,14 +36,22 @@
 # - there are likely ways to make this more efficient
 
 import argparse
+import os
 from code_retention.all_types_retention import update_alltypes_named_blocks
 from utils import get_gsrc_path_from_filename
 from code_retention.code_retention import *
+import shutil
+from pathlib import Path
+import subprocess
 
 parser = argparse.ArgumentParser("update-from-decomp")
 parser.add_argument("--game", help="The name of the game", type=str)
 parser.add_argument("--file", help="The name of the file", type=str)
-parser.add_argument("--preserve", help="Attempt to preserve comments and marked blocks", action="store_true")
+parser.add_argument(
+    "--preserve",
+    help="Attempt to preserve comments and marked blocks",
+    action="store_true",
+)
 parser.add_argument(
     "--debug", help="Output debug metadata on every block", action="store_true"
 )
@@ -61,6 +69,7 @@ comments = []
 debug_lines = []
 decomp_ignore_forms = ["defmethod inspect"]
 decomp_ignore_errors = False
+update_with_merge = False
 
 with open(gsrc_path) as f:
     lines_temp = f.readlines()
@@ -74,10 +83,28 @@ with open(gsrc_path) as f:
             decomp_ignore_errors = True
         if "og:ignore-form" in line:
             decomp_ignore_forms.append(line.partition("ignore-form:")[2].strip())
+        if "og:update-with-merge" in line:
+            update_with_merge = True
         lines.append(line)
     if args.preserve:
         comments, debug_lines = process_original_lines(lines)
 
+# If we are going to `update_with_merge` then make a backup of the file, and
+# an empty file to use as the common ancestor.
+#
+# This means that all changes will be flagged as a conflict and will not be able to be
+# merged into the repo without being explicitly resolved
+if update_with_merge:
+    subprocess.run(
+        [
+            "git",
+            "restore",
+            gsrc_path
+        ]
+    )
+    shutil.copyfile(gsrc_path, gsrc_path.replace(".gc", ".before.gc"))
+    Path(gsrc_path.replace(".gc", ".empty.gc")).touch()
+
 if args.debug:
     with open(gsrc_path, "w") as f:
         f.writelines(debug_lines)
@@ -94,7 +121,7 @@ lines_to_ignore = [
     ";; Used lq/sq",
     ";; this part is debug only",
     ";; WARN: Return type mismatch int vs none",
-    ";; WARN: Stack slot offset"
+    ";; WARN: Stack slot offset",
 ]
 
 if decomp_ignore_errors:
@@ -113,6 +140,7 @@ def should_ignore_line(line):
             return True
     return False
 
+
 # TODO - ignore brackets inside strings!
 
 decomp_file_path = "./decompiler_out/{}/{}_disasm.gc".format(args.game, args.file)
@@ -197,3 +225,29 @@ with open(gsrc_path, "w") as f:
     while i + lines_to_ignore < len(final_lines):
         f.write(final_lines[i])
         i = i + 1
+
+# If we need to merge, now is the time!
+if update_with_merge:
+    shutil.move(gsrc_path, gsrc_path.replace(".gc", ".after.gc"))
+    shutil.move(gsrc_path.replace(".gc", ".before.gc"), gsrc_path)
+    subprocess.run(
+        [
+            "git",
+            "merge-file",
+            gsrc_path,
+            gsrc_path.replace(".gc", ".empty.gc"),
+            gsrc_path.replace(".gc", ".after.gc"),
+            "-L",
+            "Before Updating",
+            "-L",
+            "ignored",
+            "-L",
+            "After Updating",
+        ]
+    )
+    if os.path.exists(gsrc_path.replace(".gc", ".empty.gc")):
+        os.remove(gsrc_path.replace(".gc", ".empty.gc"))
+    if os.path.exists(gsrc_path.replace(".gc", ".before.gc")):
+        os.remove(gsrc_path.replace(".gc", ".before.gc"))
+    if os.path.exists(gsrc_path.replace(".gc", ".after.gc")):
+        os.remove(gsrc_path.replace(".gc", ".after.gc"))