Chet

Chet -c delphi的Cheed translator

Chet是由Libclang提供Delphi的.h-to-.pas翻譯器。

特徵

與其他一些標題翻譯器不同，Chet使用Clang編譯器來解析標頭文件，從而產生更準確的翻譯，需要更少的手動調整。

一些值得注意的功能是：

• 翻譯C數據類型，例如結構，聯合，枚舉，Typedefs，程序類型和不透明類型。
• 將C功能轉換為Delphi過程或功能。
• 試圖在可能的情況下將#define聲明翻譯成常數。
• 為.h文件的整個目錄生成一個.pas文件。這減少了由於標題文件之間的依賴關係而引起的問題。
• 如果需要，為多個平台（WinSows，MacOS，Linux，iOS和Android）生成輸出。
• 您可以通過向編譯器提供命令行參數來自定義clang解析過程。
• 您可以自定義一些轉換操作的輸出。
• 如果需要，請保留任何Doxygen樣式文檔註釋，或將其轉換為XMLDOC註釋或PASDOC評論。
• 提供用於配置轉換過程的GUI，並允許您將轉換設置保存到.chet項目文件以進行重複使用。

限制

• CHET僅與C標頭文件一起使用，而不適用於C ++標頭文件。
• 標題文件中的所有非插入功能均已翻譯並假定在項目的靜態或動態庫中可用。不必是這種情況。 （由於庫中從未有過內線的函數，因此永遠不會翻譯它們。）
• 由於Clang用於解析標頭文件，因此這意味著Clangs預處理程序也運行以執行有條件的解析（在#ifdef指令的指導下）。這既是好又壞。這很好，因為它提高了轉換精度。但這可能很糟糕，因為它使用Chet運行的系統來確定某些條件路徑。例如，由於Chet在Windows上運行，因此它將在#ifdef _WIN32節中解析代碼，但請跳過其他平台中的任何代碼。

要求

由於Chet使用了實際的編譯器，因此您將需要安裝（最小）C開發環境以及使用Clang的LLVM。 Clang需要能夠找到用於開發環境的系統標題。如果您安裝了帶有Visual C ++的Visual Studio，則通常可以使用這些。 Visual Studio的免費（社區）版本就足夠了。

您可以首先運行CHET，以檢查與缺失依賴關係有關的任何錯誤。如果運行翻譯器時會遇到任何依賴關係錯誤，則可以在此處下載依賴項：

• LLVM帶有clang（建議使用Windows（64位））。
• Visual Studio IDE（免費的社區版本就足夠；請確保安裝C ++支持）。

您可以在Bin目錄中使用預編譯的64位Windows Chet應用程序。

如果您想自己編譯Chet，那麼您還需要Delphi的Libclang，並確保Delphi IDE可以找到它（如果Neslib.Clang目錄與Chet Directory的級別相同）。

貢獻

謝謝您的這些貢獻：

• MichałSznajder改進了炭轉化。
• Chiptamer增加了對鍵入的const聲明的支持。
• 賈羅德·戴維斯（Jarrod Davis）增加了後處理支持。
• Alexey.t，以添加對C結構，用戶定義的類型映射中包裝的位字段的支持以及忽略某些標頭文件的能力。

用戶指南

切特非常簡單。在許多情況下，您只需要提供標頭文件的目錄，輸出.pas文件的名稱，然後選擇“運行標頭轉換器（F9）”。

要獲得對轉換過程的更多控制，您可以指定下面描述的各種選項。

菜單

您設置的任何配置選項都可以保存到.chet配置文件（這是一個簡單的Ini-File）。這使您稍後可以加載設置以重新運行轉換（例如，當發布了標題文件的新版本時）。您可以使用File菜單加載並保存這些配置選項。

要幫助預配置新會話的某些設置，請選擇File | New Project... (Ctrl+N) 。您輸入項目的名稱，Chet將根據您輸入的名稱預先配置某些設置（儘管您稍後可以始終修改這些設置）。

就像單個選項Run Run Header Translator一樣，您也可以使用F9激活。

項目頁面

項目頁麵包含最重要的配置選項：

• 帶有C標頭文件的目錄：在此處指定使用源.h文件的目錄。該目錄可以相對於包含.chet項目文件的目錄。單擊...按鈕以瀏覽目錄。建議您不要將目錄與原始C源代碼一起使用。而是將標題文件複製到僅出於轉換目的的單獨目錄。這使得更輕鬆地刪除不想轉換的標頭文件，或者將編輯為轉換目的進行編輯。
• 包括子目錄：如果標題文件分佈在多個目錄中，請選中此框。在這種情況下，Chet也將搜索給定目錄的所有子目錄。
• 目標pascal文件：指定將生成的.pas文件的名稱。我將為所有解析的標頭文件生成單一組合的pascal文件。該名稱可以相對於包含.chet項目文件的目錄。單擊...按鈕打開一個保存對話框。
• 逗號分隔為“使用”的單位列表：如果標題文件取決於其他一些Delphi單元中的聲明（例如Windows.Winapi ），則可以在此處列出這些單元。將添加到生成的pascal文件的使用條款中。

平台頁面

在此頁面上，您指定要定位的平台以及如何配置它們。

• 庫常數：指定用於庫名稱的常數名稱。例如，如果您有一個稱為“ mylib.dll”的庫，則該常數的名稱可以是LIB_MYLIB ，因此將生成以下聲明： const LIB_MYLIB = 'mylib.dll' 。

接下來是您要定位的所有平台的複選框（32位窗口，64位Windows，32位MacOS，64位Linux，iOS和Android）。對於您檢查的每個平台，您必須輸入以下選項：

• 庫名：平台的動態或靜態庫的名稱**。
• 前綴（_PU） ：用於平台的功能名稱前綴。通常可以將其留為空。但是，根據庫的構建方式，所有函數名稱都可以前綴（通常具有下劃線_字符）。

解析選項頁面

在這裡，您可以自定義Clang解析過程。

• 忽略解析錯誤：選中此框以忽略任何解析錯誤，然後嘗試轉換標題文件。請注意，這可能會導致輸出不正確，因此您通常應該將此選項放在不受歡迎。您可能會發現此選項可作為檢查解析錯誤的臨時選項。通常，在遇到第一個致命錯誤之後，Clang將停止解析。通過選中此框，它將顯示所有解析錯誤（最高限制），因此您可以解決這些錯誤，然後再次選中此框。
• 命令行參數傳遞到clang ：在此處指定任何命令行參數以將其傳遞到Clang編譯器。通常不需要這一點，但是有些C項目可能需要一些命令行論證才能取得成功。您可能需要的最常見的命令行參數是添加預處理器定義（ -D<define> ），並包括搜索路徑（ -I<path> ）。有單獨的按鈕可以更輕鬆地添加這些按鈕。有關可用命令行參數的信息，請參閱叮噹文檔。

轉換選項

這是您自定義生成的輸出的地方。

• 調用約定：指定用於所有翻譯功能的調用約定。您可以在cdecl和stdcall之間進行選擇。在幾乎所有情況下，您都應使用默認的cdecl調用約定。僅適用於32位Windows DLL的stdcall ，您知道它是通過stdcall呼叫約定編譯的。這些通常只是Windows系統DLL。大多數第三方DLL的使用CDECL。
• 評論處理：在這裡您指定如何處理文檔評論（另請參見下面的註釋）：
  • 保持評論為IS （默認）：請勿轉換評論，而要以其原始（doxygen）樣式保持評論。
  • 刪除評論：所有評論將被刪除。
  • 將註釋轉換為XMLDOC樣式（實驗） ：將Doxygen風格的註釋轉換為XMLDOC樣式註釋（Delphi的默認文檔樣式）。此功能仍在建設中，並被認為是實驗性的。
  • 將註釋轉換為PASDOC樣式（實驗） ：將Doxygen風格的評論轉換為Pasdoc樣式評論。此功能仍在建設中，並被認為是實驗性的。
• 將“ char”轉換為：C char類型是模棱兩可的，可以用作8位整數或文本字符串中的字符。 signed char和unsigned char字符始終分別轉換為Shortint和Byte 。但是，如果未指定簽名性，則有以下選項：
  • UTF8CHAR （默認）：將char轉換為跨平台UTF8Char 。
  • 肖特：將char轉換為8位簽名的Shortint 。
  • 字節：將char轉換為8位未簽名的Byte 。
• 保留單詞處理：標頭文件可以使用與Delphi中的保留單詞相衝突的標識符（例如begin和procedure ）。在這裡，您指定要如何轉換這些標識符：
  • 添加領先的'＆' （默認）：將標識符帶有ampersand。
  • 添加領先的'_' ：以下劃線為前綴標識符。
  • 添加尾隨的“ _' ：在標識符的末端添加下劃線。
• 將指令視為保留的單詞：是否也將Delphi指令視為保留單詞（默認情況下檢查）。從技術上講，您可以將許多指令（例如public ）用作Delphi中的標識符，但看起來很奇怪，Delphi的語法熒光筆對它們的對待有所不同。因此，您通常也希望將這些視為保留的單詞。
• 枚舉處理：您可以選擇以兩種方式轉換C枚舉：
  • 轉換為枚舉類型（默認）：轉換為Delphi枚舉類型。
  • 轉換為整數類型和常數：將類型名稱本身轉換為整數（如type MyEnum = Integer; ），並為枚舉中的每個選項創建常數。這可能更適用於某些庫。
• 不可逆轉的聲明：儘管盡了最大的努力，Chet可能無法轉換所有聲明（尤其是#define ，請參見下面的評論）。在這裡，您指定如何處理這些：
  • 編寫TODO項目（默認）：將TODO評論寫入Delphi源代碼，以及原始聲明的評論版本。請記住，您可以通過選擇View | Tool Windows | To-Do List 。
  • 註釋原始聲明：將原始聲明的評論版本寫入Delphi源代碼。
  • 忽略聲明：忽略聲明，不會為Delphi源代碼寫任何內容。

請注意，Clang僅對Doxygen樣式文檔註釋進行了解析。這些是遵循這些格式慣例的任何評論：

• /// Comment (with 3 slashes)
• /** Comment (with two stars) */
• /*! Comment (with exclamation point) */
• ///< Comment (applies to preceding declaration)
• /**< Comment (applies to preceding declaration) */
• /*!< Comment (applies to preceding declaration) */

如果可能的話，Chet試圖將#define聲明轉換為常數。這僅在以下情況下起作用：

• 定義不像功能一樣。也就是說，像#define ABS(x) (x < 0) ? -x : x無法翻譯。
• 定義使用僅使用其他定義和文字的表達式。例如： #define FOO 3<<BAR將轉換為const FOO = 3 shl BAR 。

忽略頁面

在這裡，您可以指定要忽略的符號列表。這些符號不會翻譯。

最常見的用途是忽略#define的轉換錯誤或您不需要的功能。您還可以選擇忽略某些類型，但這可能會導致以後導致編譯錯誤，因為預期類型缺少。

請注意，符號對大小寫。

翻譯頁面

最後一頁只有一個按鈕“ Run Header Translator”（您也可以使用F9激活）。它顯示了翻譯過程的進度以及解析標頭文件時發生的任何錯誤。

您可以使用這些錯誤來修復標頭文件，添加缺少的標頭文件，或通過添加命令行參數來配置解析過程（例如，通過添加Include Include搜索路徑）。

執照

Chet是根據簡化的BSD許可證獲得許可的。有關詳細信息，請參見License.txt。