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。