diff --git a/.github/workflows/pr-code-format.yml b/.github/workflows/pr-code-format.yml
new file mode 100644
index 000000000..6e45f9b3d
--- /dev/null
+++ b/.github/workflows/pr-code-format.yml
@@ -0,0 +1,75 @@
+# Inspired by LLVM's pr-code-format.yml at
+# https://github.com/llvm/llvm-project/blob/main/.github/workflows/pr-code-format.yml
+
+name: "Check code formatting"
+on:
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ code_formatter:
+ runs-on: [self-hosted, X64]
+ if: github.repository == 'FEX-Emu/FEX'
+
+ steps:
+ - name: Fetch FEX sources
+ uses: actions/checkout@v4
+ with:
+ ref: ${{ github.event.pull_request.head.sha }}
+
+ - name: Checkout through merge base
+ uses: rmacklin/fetch-through-merge-base@v0
+ with:
+ base_ref: ${{ github.event.pull_request.base.ref }}
+ head_ref: ${{ github.event.pull_request.head.sha }}
+ deepen_length: 500
+
+ - name: Get changed files
+ id: changed-files
+ uses: tj-actions/changed-files@v39
+ with:
+ separator: ","
+ skip_initial_fetch: true
+
+ - name: "Listed files"
+ env:
+ CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
+ run: |
+ echo "Formatting files:"
+ echo "$CHANGED_FILES"
+
+ - name: Check for correct clang-format version
+ run: clang-format --version | grep -qF '16.0.6'
+
+ - name: Check git-clang-format-16 exists
+ run: which git-clang-format-16
+
+ - name: Setup Python env
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.11'
+ cache: 'pip'
+ cache-dependency-path: './External/code-format-helper/requirements_formatting.txt'
+
+ - name: Install python dependencies
+ run: pip install -r ./External/code-format-helper/requirements_formatting.txt
+
+ - name: Run code formatter
+ env:
+ CLANG_FORMAT_PATH: 'git-clang-format-16'
+ GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
+ START_REV: ${{ github.event.pull_request.base.sha }}
+ END_REV: ${{ github.event.pull_request.head.sha }}
+ CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
+ # TODO(pmatos): Once we adopt v18, we should be able
+ # to take advantage of the new --diff_from_common_commit option
+ # explicitly in code-format-helper.py and not have to diff starting at
+ # the merge base.
+ run: |
+ python ./External/code-format-helper/code-format-helper.py \
+ --repo "FEX-emu/FEX" \
+ --issue-number $GITHUB_PR_NUMBER \
+ --start-rev $(git merge-base $START_REV $END_REV) \
+ --end-rev $END_REV \
+ --changed-files "$CHANGED_FILES"
diff --git a/External/code-format-helper/code-format-helper.py b/External/code-format-helper/code-format-helper.py
new file mode 100644
index 000000000..176839849
--- /dev/null
+++ b/External/code-format-helper/code-format-helper.py
@@ -0,0 +1,394 @@
+#!/usr/bin/env python3
+#
+# ====- code-format-helper, runs code formatters from the ci or in a hook --*- python -*--==#
+#
+# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+# See https://llvm.org/LICENSE.txt for license information.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+#
+# ==--------------------------------------------------------------------------------------==#
+
+import argparse
+import os
+import subprocess
+import sys
+from typing import List, Optional
+
+"""
+This script is run by GitHub actions to ensure that the code in PR's conform to
+the coding style of LLVM. It can also be installed as a pre-commit git hook to
+check the coding style before submitting it. The canonical source of this script
+is in the LLVM source tree under llvm/utils/git.
+
+For C/C++ code it uses clang-format and for Python code it uses darker (which
+in turn invokes black).
+
+You can learn more about the LLVM coding style on llvm.org:
+https://llvm.org/docs/CodingStandards.html
+
+You can install this script as a git hook by symlinking it to the .git/hooks
+directory:
+
+ln -s $(pwd)/llvm/utils/git/code-format-helper.py .git/hooks/pre-commit
+
+You can control the exact path to clang-format or darker with the following
+environment variables: $CLANG_FORMAT_PATH and $DARKER_FORMAT_PATH.
+"""
+
+
+class FormatArgs:
+ start_rev: str = None
+ end_rev: str = None
+ repo: str = None
+ changed_files: List[str] = []
+ token: str = None
+ verbose: bool = True
+ issue_number: int = 0
+ write_comment_to_file: str = None
+
+ def __init__(self, args: argparse.Namespace = None) -> None:
+ if not args is None:
+ self.start_rev = args.start_rev
+ self.end_rev = args.end_rev
+ self.repo = args.repo
+ self.token = args.token
+ self.changed_files = args.changed_files
+ self.issue_number = args.issue_number
+ self.write_comment_to_file = args.write_comment_to_file
+
+
+class FormatHelper:
+ COMMENT_TAG = ""
+ name: str
+ friendly_name: str
+ comment: dict = None
+
+ @property
+ def comment_tag(self) -> str:
+ return self.COMMENT_TAG.replace("fmt", self.name)
+
+ @property
+ def instructions(self) -> str:
+ raise NotImplementedError()
+
+ def has_tool(self) -> bool:
+ raise NotImplementedError()
+
+ def format_run(self, changed_files: List[str], args: FormatArgs) -> Optional[str]:
+ raise NotImplementedError()
+
+ def pr_comment_text_for_diff(self, diff: str) -> str:
+ return f"""
+:warning: {self.friendly_name}, {self.name} found issues in your code. :warning:
+
+
+
+You can test this locally with the following command:
+
+
+``````````bash
+{self.instructions}
+``````````
+
+
+
+
+
+View the diff from {self.name} here.
+
+
+``````````diff
+{diff}
+``````````
+
+
+"""
+
+ # TODO: any type should be replaced with the correct github type, but it requires refactoring to
+ # not require the github module to be installed everywhere.
+ def find_comment(self, pr: any) -> any:
+ for comment in pr.as_issue().get_comments():
+ if self.comment_tag in comment.body:
+ return comment
+ return None
+
+ def update_pr(self, comment_text: str, args: FormatArgs, create_new: bool) -> None:
+ import github
+ from github import IssueComment, PullRequest
+
+ repo = github.Github(args.token).get_repo(args.repo)
+ pr = repo.get_issue(args.issue_number).as_pull_request()
+
+ comment_text = self.comment_tag + "\n\n" + comment_text
+
+ existing_comment = self.find_comment(pr)
+
+ if args.write_comment_to_file:
+ if create_new or existing_comment:
+ self.comment = {"body": comment_text}
+ if existing_comment:
+ self.comment["id"] = existing_comment.id
+ return
+
+ if existing_comment:
+ existing_comment.edit(comment_text)
+ elif create_new:
+ pr.as_issue().create_comment(comment_text)
+
+ def run(self, changed_files: List[str], args: FormatArgs) -> bool:
+ changed_files = [arg for arg in changed_files if "third-party" not in arg]
+ diff = self.format_run(changed_files, args)
+ should_update_gh = args.token is not None and args.repo is not None
+
+ if diff is None:
+ if should_update_gh:
+ comment_text = (
+ ":white_check_mark: With the latest revision "
+ f"this PR passed the {self.friendly_name}."
+ )
+ self.update_pr(comment_text, args, create_new=False)
+ return True
+ elif len(diff) > 0:
+ if should_update_gh:
+ comment_text = self.pr_comment_text_for_diff(diff)
+ self.update_pr(comment_text, args, create_new=True)
+ else:
+ print(
+ f"Warning: {self.friendly_name}, {self.name} detected "
+ "some issues with your code formatting..."
+ )
+ return False
+ else:
+ # The formatter failed but didn't output a diff (e.g. some sort of
+ # infrastructure failure).
+ comment_text = (
+ f":warning: The {self.friendly_name} failed without printing "
+ "a diff. Check the logs for stderr output. :warning:"
+ )
+ self.update_pr(comment_text, args, create_new=False)
+ return False
+
+
+class ClangFormatHelper(FormatHelper):
+ name = "clang-format"
+ friendly_name = "C/C++ code formatter"
+
+ @property
+ def instructions(self) -> str:
+ return " ".join(self.cf_cmd)
+
+ def should_include_extensionless_file(self, path: str) -> bool:
+ return path.startswith("libcxx/include")
+
+ def filter_changed_files(self, changed_files: List[str]) -> List[str]:
+ filtered_files = []
+ for path in changed_files:
+ _, ext = os.path.splitext(path)
+ if ext in (".cpp", ".c", ".h", ".hpp", ".hxx", ".cxx", ".inc", ".cppm"):
+ filtered_files.append(path)
+ elif ext == "" and self.should_include_extensionless_file(path):
+ filtered_files.append(path)
+ return filtered_files
+
+ @property
+ def clang_fmt_path(self) -> str:
+ if "CLANG_FORMAT_PATH" in os.environ:
+ return os.environ["CLANG_FORMAT_PATH"]
+ return "git-clang-format"
+
+ def has_tool(self) -> bool:
+ cmd = [self.clang_fmt_path, "-h"]
+ proc = None
+ try:
+ proc = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ except:
+ return False
+ return proc.returncode == 0
+
+ def format_run(self, changed_files: List[str], args: FormatArgs) -> Optional[str]:
+ cpp_files = self.filter_changed_files(changed_files)
+ if not cpp_files:
+ return None
+
+ cf_cmd = [self.clang_fmt_path, "--diff"]
+
+ if args.start_rev and args.end_rev:
+ cf_cmd.append(args.start_rev)
+ cf_cmd.append(args.end_rev)
+
+ cf_cmd.append("--")
+ cf_cmd += cpp_files
+
+ if args.verbose:
+ print(f"Running: {' '.join(cf_cmd)}")
+ self.cf_cmd = cf_cmd
+ proc = subprocess.run(cf_cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ sys.stdout.write(proc.stderr.decode("utf-8"))
+
+ if proc.returncode != 0:
+ # formatting needed, or the command otherwise failed
+ if args.verbose:
+ print(f"error: {self.name} exited with code {proc.returncode}")
+ # Print the diff in the log so that it is viewable there
+ print(proc.stdout.decode("utf-8"))
+ return proc.stdout.decode("utf-8")
+ else:
+ return None
+
+
+class DarkerFormatHelper(FormatHelper):
+ name = "darker"
+ friendly_name = "Python code formatter"
+
+ @property
+ def instructions(self) -> str:
+ return " ".join(self.darker_cmd)
+
+ def filter_changed_files(self, changed_files: List[str]) -> List[str]:
+ filtered_files = []
+ for path in changed_files:
+ name, ext = os.path.splitext(path)
+ if ext == ".py":
+ filtered_files.append(path)
+
+ return filtered_files
+
+ @property
+ def darker_fmt_path(self) -> str:
+ if "DARKER_FORMAT_PATH" in os.environ:
+ return os.environ["DARKER_FORMAT_PATH"]
+ return "darker"
+
+ def has_tool(self) -> bool:
+ cmd = [self.darker_fmt_path, "--version"]
+ proc = None
+ try:
+ proc = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ except:
+ return False
+ return proc.returncode == 0
+
+ def format_run(self, changed_files: List[str], args: FormatArgs) -> Optional[str]:
+ py_files = self.filter_changed_files(changed_files)
+ if not py_files:
+ return None
+ darker_cmd = [
+ self.darker_fmt_path,
+ "--check",
+ "--diff",
+ ]
+ if args.start_rev and args.end_rev:
+ darker_cmd += ["-r", f"{args.start_rev}...{args.end_rev}"]
+ darker_cmd += py_files
+ if args.verbose:
+ print(f"Running: {' '.join(darker_cmd)}")
+ self.darker_cmd = darker_cmd
+ proc = subprocess.run(
+ darker_cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE
+ )
+ if args.verbose:
+ sys.stdout.write(proc.stderr.decode("utf-8"))
+
+ if proc.returncode != 0:
+ # formatting needed, or the command otherwise failed
+ if args.verbose:
+ print(f"error: {self.name} exited with code {proc.returncode}")
+ # Print the diff in the log so that it is viewable there
+ print(proc.stdout.decode("utf-8"))
+ return proc.stdout.decode("utf-8")
+ else:
+ sys.stdout.write(proc.stdout.decode("utf-8"))
+ return None
+
+
+ALL_FORMATTERS = (DarkerFormatHelper(), ClangFormatHelper())
+
+
+def hook_main():
+ # fill out args
+ args = FormatArgs()
+ args.verbose = False
+
+ # find the changed files
+ cmd = ["git", "diff", "--cached", "--name-only", "--diff-filter=d"]
+ proc = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ output = proc.stdout.decode("utf-8")
+ for line in output.splitlines():
+ args.changed_files.append(line)
+
+ failed_fmts = []
+ for fmt in ALL_FORMATTERS:
+ if fmt.has_tool():
+ if not fmt.run(args.changed_files, args):
+ failed_fmts.append(fmt.name)
+ if fmt.comment:
+ comments.append(fmt.comment)
+ else:
+ print(f"Couldn't find {fmt.name}, can't check " + fmt.friendly_name.lower())
+
+ if len(failed_fmts) > 0:
+ sys.exit(1)
+
+ sys.exit(0)
+
+
+if __name__ == "__main__":
+ script_path = os.path.abspath(__file__)
+ if ".git/hooks" in script_path:
+ hook_main()
+ sys.exit(0)
+
+ parser = argparse.ArgumentParser()
+ parser.add_argument(
+ "--token", type=str, required=False, help="GitHub authentication token"
+ )
+ parser.add_argument(
+ "--repo",
+ type=str,
+ default=os.getenv("GITHUB_REPOSITORY", "llvm/llvm-project"),
+ help="The GitHub repository that we are working with in the form of / (e.g. llvm/llvm-project)",
+ )
+ parser.add_argument("--issue-number", type=int, required=True)
+ parser.add_argument(
+ "--start-rev",
+ type=str,
+ required=True,
+ help="Compute changes from this revision.",
+ )
+ parser.add_argument(
+ "--end-rev", type=str, required=True, help="Compute changes to this revision"
+ )
+ parser.add_argument(
+ "--changed-files",
+ type=str,
+ help="Comma separated list of files that has been changed",
+ )
+ parser.add_argument(
+ "--write-comment-to-file",
+ type=str,
+ help="Don't post comments on the PR, instead write the comments and metadata a file",
+ )
+
+ args = FormatArgs(parser.parse_args())
+
+ changed_files = []
+ if args.changed_files:
+ changed_files = args.changed_files.split(",")
+
+ failed_formatters = []
+ comments = []
+ for fmt in ALL_FORMATTERS:
+ if not fmt.run(changed_files, args):
+ failed_formatters.append(fmt.name)
+ if fmt.comment:
+ comments.append(fmt.comment)
+
+ if len(comments):
+ with open(args.write_comment_to_file, "w") as f:
+ import json
+
+ json.dump(comments, f)
+
+ if len(failed_formatters) > 0:
+ print(f"error: some formatters failed: {' '.join(failed_formatters)}")
+ sys.exit(1)
diff --git a/External/code-format-helper/requirements_formatting.txt b/External/code-format-helper/requirements_formatting.txt
new file mode 100644
index 000000000..ff744f0d4
--- /dev/null
+++ b/External/code-format-helper/requirements_formatting.txt
@@ -0,0 +1,52 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+# pip-compile --output-file=llvm/utils/git/requirements_formatting.txt llvm/utils/git/requirements_formatting.txt.in
+#
+black==23.9.1
+ # via
+ # -r llvm/utils/git/requirements_formatting.txt.in
+ # darker
+certifi==2023.7.22
+ # via requests
+cffi==1.15.1
+ # via
+ # cryptography
+ # pynacl
+charset-normalizer==3.2.0
+ # via requests
+click==8.1.7
+ # via black
+cryptography==41.0.3
+ # via pyjwt
+darker==1.7.2
+ # via -r llvm/utils/git/requirements_formatting.txt.in
+deprecated==1.2.14
+ # via pygithub
+idna==3.4
+ # via requests
+mypy-extensions==1.0.0
+ # via black
+packaging==23.1
+ # via black
+pathspec==0.11.2
+ # via black
+platformdirs==3.10.0
+ # via black
+pycparser==2.21
+ # via cffi
+pygithub==1.59.1
+ # via -r llvm/utils/git/requirements_formatting.txt.in
+pyjwt[crypto]==2.8.0
+ # via pygithub
+pynacl==1.5.0
+ # via pygithub
+requests==2.31.0
+ # via pygithub
+toml==0.10.2
+ # via darker
+urllib3==2.0.4
+ # via requests
+wrapt==1.15.0
+ # via deprecated