HAN JIE

🚀 XenonRecomp 編譯器文檔

XenonRecomp 是一款專門用於將 PowerPC（PPC）彙編代碼轉換為 C++ 的工具，在遊戲模擬器開發領域發揮著重要作用。本文檔將詳細闡述 XenonRecomp 的使用方法和配置要點，涵蓋其功能特性、輸入輸出格式、配置選項以及測試方式等內容。

🚀 快速開始

編譯要求

項目要求 CMake 3.20 或更高版本和 Clang 18 或更高版本。由於倉庫包含子模塊，確保使用 git clone --recursive 進行克隆。

僅推薦使用 Clang 編譯器進行開發，因為項目依賴於 Clang 的特定特性。在 Windows 上，可以使用 clang-cl 工具鏈，並通過 Visual Studio 的 CMake 集成進行開發。

測試轉換

XenonRecomp 可以處理 Xenia 項目的 PPC 測試並生成相應的 C++ 文件。通過以下命令進行轉換：

XenonRecomp [輸入測試目錄路徑] [輸入 PPC 上下文頭文件路徑] [輸出目錄路徑]

生成的文件可以在 src/xenia/cpu/ppc/testing/bin 目錄中找到。

✨ 主要特性

1. 中斷處理

在 config.toml 配置文件中，用戶可以定義需要跳過的代碼段：

# 禁用中斷處理的彙編代碼轉換為 C++
skip_assembler = ["Altivec"]

2. 調試鉤子

通過 config.toml 配置文件，用戶可以插入自定義調試鉤子：

[[debug_hook]]
name = "調試鉤子示例"
address = 0x12345678
registers = ["r0", "r1"]

3. 自定義轉換規則

在 rules.toml 文件中，用戶可以自定義彙編指令到 C++ 的轉換規則：

# 示例：將 PPC 指令 'add' 轉換為 C++ 表達式 'r0 = r1 + r2'
[add]
cpp = "r0 = r1 + r2;"

📦 安裝指南

此文檔未提及具體安裝步驟，若有需要可根據編譯要求進行環境搭建。

📚 詳細文檔

輸入輸出格式

輸入格式

XenonRecomp 接受以下輸入：

• PPC 彙編代碼文件：包含需要轉換的 PPC 彙編指令。
• 上下文頭文件：定義了彙編代碼中使用的寄存器和其他上下文信息。

輸出格式

轉換後的 C++ 文件，其中包含了將彙編指令轉換為 C++ 代碼後的結果。輸出文件的位置由用戶指定。

配置選項

XenonRecomp 提供以下配置選項：

• 輸入目錄：指定包含 PPC 彙編代碼和上下文頭文件的目錄路徑。
• 輸出目錄：指定生成轉換後 C++ 文件的目標位置。
• 調試模式：啟用調試信息，便於調試和排錯。

📄 許可證

此文檔未提及許可證信息。

🔗 特別感謝

本項目得以實現離不開 Xenia 模擬器的 PPC 代碼轉換器的參考。項目還使用了來自 Xenia Canary 的補丁來處理 XEX 二進制文件。