Chet

Chet - C Header Translator для Delphi

Чет-это переводчик .h-to-.pas

Функции

В отличие от некоторых других переводчиков заголовков, Чет использует компилятор Clang для анализа файлов заголовков, что приводит к более точным переводам, которые требуют меньше ручных корректировок.

Некоторые примечательные функции:

• Переводит типы данных C, такие как структуры, объединение, перечисление, типы, процедурные типы и непрозрачные типы.
• Перевод функций C на процедуры или функции Delphi.
• Пытается перевести #define Declararations на постоянные, где это возможно.
• Генерирует один файл .pas для всего каталога .h файлов. Это уменьшает проблемы из -за зависимости между файлами заголовков.
• При желании генерирует вывод для нескольких платформ (Winsows, MacOS, Linux, iOS и Android).
• Вы можете настроить процесс анализа кланг, предоставив компилятор аргументы командной строки.
• Вы можете настроить вывод некоторых операций конверсии.
• Сохраняет любые документы в стиле доксигена, если это необходимо, или преобразует их в комментарии XMLDOC или комментарии Pasdoc.
• Предоставляет графический интерфейс для настройки процесса преобразования и позволяет сохранить настройки преобразования в файл проекта .chet для повторного использования.

Ограничения

• Chet работает только с файлами заголовка C, а не с файлами заголовков C ++.
• Все не инлинированные функции в файлах заголовков переводятся и предполагаются, что они доступны в статической или динамической библиотеке для проекта. Это не должно быть так. (Вставленные функции никогда не переводятся, поскольку они никогда не доступны в библиотеке.)
• Поскольку Clang используется для анализа файлов заголовков, это означает, что кланг препроцессор также работает для выполнения условного анализа (руководство с помощью директив #ifdef ). Это и хорошо, и плохо. Это хорошо, потому что это повышает точность конверсии. Но это может быть плохо, потому что он использует систему, на которой работает Чет, чтобы определить некоторые условные пути. Например, поскольку Chet работает в Windows, он будет проанализировать код в разделах #ifdef _WIN32 но пропустит любой код в разделах для других платформ.

Требования

Поскольку Chet использует фактический компилятор, вам нужно будет иметь (минимальную) разработку среды C, а также LLVM с Clang. Кланг должен иметь возможность найти заголовки системы для среды разработки. Обычно они будут доступны, если у вас есть какая -то версия Visual Studio с установленным Visual C ++. Бесплатного (сообщества) издания Visual Studio достаточно.

Сначала вы можете запустить Chet, чтобы проверить любые ошибки, связанные с отсутствующими зависимостями. Если вы получаете какие -либо ошибки зависимости при запуске переводчика, то вы можете скачать зависимости здесь:

• LLVM с Clang (Clang для Windows (64-битный) рекомендуется).
• Visual Studio IDE (бесплатное издание сообщества достаточно; обязательно установите поддержку C ++).

Вы можете использовать предварительно скомпилированное 64-битное приложение Windows Chet в каталоге Bin .

Если вы хотите скомпилировать Chet сами, вам также нужен Libclang для Delphi и убедитесь, что Delphi IDE может его найти (проект CHET найдет его автоматически, если каталог Neslib.Clang находится на том же уровне, что и каталог Chet ).

Вклад

Спасибо за этот вклад:

• Михал Шнадждер для улучшения конверсий ЧАР.
• Chiptamer для добавления поддержки для типизированных объявлений Const.
• Джаррод Дэвис за добавление поддержки после обработки.
• Alexey.t для добавления поддержки упакованных битовых полей в C-структурах, пользовательских сопоставлениях типа и возможность игнорировать определенные файлы заголовков.

Руководство пользователя

Чет довольно прост. Во многих случаях вам нужно только предоставить каталог с файлами заголовка, имя выходного файла .pas и выбрать «Запуск заголовка (F9)».

Для получения дополнительной контроля над процессом преобразования вы можете указать различные параметры, описанные ниже.

Меню

Любые параметры конфигурации, которые вы устанавливаете, можно сохранить в файле конфигурации .chet (который является простым INI-FILE). Это позволяет вам загрузить настройки позже, чтобы повторить преобразование (например, когда были выпущены новые версии файлов заголовка). Вы можете загрузить и сохранить эти параметры конфигурации, используя меню File .

Чтобы помочь предварительно сконфигурировать некоторые настройки для нового сеанса, выберите File | New Project... (Ctrl+N) . Вы вводите имя проекта, и Chet будет предварительно настроить некоторые настройки на основе введенного вами имени (хотя вы всегда можете изменить эти настройки позже).

Меню Run As Allow As One Option Run Header Translator , который вы также можете активировать с помощью F9 .

Project Page

Страница проекта содержит наиболее важные параметры конфигурации:

• Справочник с файлами заголовка C : укажите каталог с файлами Source .h здесь. Каталог может быть относительно каталога, содержащего файл проекта .chet . Нажмите кнопку ... чтобы просмотреть каталог. Рекомендуется не использовать каталог с исходным исходным кодом C. Вместо этого скопируйте файлы заголовка в отдельный каталог только для целей конверсии. Это облегчает удаление файлов заголовков, которые вы не хотите преобразовать, или вносить изменения в файлы заголовков для целей конверсии.
• Включите подкатализаторы : установите этот флажок, если файлы заголовка разбросаны по нескольким каталогам. В этом случае Чет также будет искать все подкаталоги данного каталога.
• Целевой файл Pascal : укажите имя файла .pas , который будет сгенерирован. Я будет сгенерирован в одном комбинированном файле Pascal для всех файлов заголовков. Имя может быть относительно каталога, содержащего файл проекта .chet . Нажмите кнопку ... , чтобы открыть диалог сохранения.
• Список единиц, разделенный запятыми для «использования» : если файлы заголовков зависят от объявлений в некоторых других единицах Delphi (например, Windows.Winapi ), то вы можете перечислить эти единицы здесь. Будет добавлено в пункт использования сгенерированного файла Pascal.

Страница платформ

На этой странице вы указываете, на какие платформы вы хотите нацелиться, и как вы хотите их настроить.

• Постоянная библиотека : укажите имя постоянной для использования для имени библиотеки. Например, если у вас есть библиотека под названием «mylib.dll», то имя этой константы может быть LIB_MYLIB , поэтому будет сгенерировано следующее объявление: const LIB_MYLIB = 'mylib.dll' .

Далее следуют флажки для всех платформ, на которые вы хотите нацелиться (32-разрядные Windows, 64-битные Windows, 32-битный MacOS, 64-битный Linux, iOS и Android). Для каждой платформы, которую вы проверяете, вы должны ввести следующие параметры:

• Имя библиотеки : имя динамической или статической библиотеки для платформы **. **
• Префикс (_PU) : префикс имени функции для использования для платформы. Обычно это можно оставить пустым. Но, в зависимости от того, как строится библиотека, все имена функций могут быть префикс (обычно с подчеркивающим _ символом).

Страница параметров анализа

Здесь вы можете настроить процесс анализа кланг.

• Игнорируйте ошибки PANSE : установите этот флажок, чтобы игнорировать любые ошибки анализа и в любом случае попытаться перевести файлы заголовка. Обратите внимание, что это может привести к неправильному выводу, поэтому вы, как правило, должны оставить эти параметры без контроля. Вы можете найти эту опцию полезной в качестве временной опции для проверки ошибок анализа. Обычно Clang останавливает анализ после того, как он столкнется с первой фатальной ошибкой. Проверяя эту коробку, он будет показывать все ошибки анализа (до предела), так что вы можете обратиться к ним, а затем снова снять с ног.
• Аргументы командной строки для передачи в Clang : укажите любые аргументы командной строки, чтобы передать компилятор Clang здесь. Обычно в этом нет необходимости, но некоторые проекты C могут потребовать некоторых аргументов командной строки для успеха. Наиболее распространенными аргументами командной строки, которые вам могут понадобиться, являются добавление препроцессора определяет ( -D<define> ) и включают пути поиска ( -I<path> ). Есть отдельные кнопки, чтобы облегчить их добавление. Обратитесь к документации Clang для получения информации о доступных аргументах командной строки.

Параметры конверсии

Здесь вы настраиваете сгенерированный вывод.

• Вызовов Конвенции : Укажите призывную конвенцию для использования для всех переведенных функций. Вы можете выбрать между cdecl и stdcall . Почти во всех случаях вы должны использовать соглашение о вызове cdecl по умолчанию. Используйте stdcall только для 32-битных DLL Windows, которые, как вы знаете, составлены с соглашением о вызове STDCALL. Обычно это только Windows System DLL. Большинство сторонних DLL используют CDECL.
• Обработка комментариев : здесь вы указываете, как обрабатывать комментарии документации (см. Также замечания ниже):
  • Держите комментарии как есть (по умолчанию): не конвертируйте комментарии, но держите их в своем оригинальном (доксигенном) стиле.
  • Удалить комментарии : все комментарии будут удалены.
  • Конвертируйте комментарии в стиль XMLDOC (экспериментальный) : преобразует комментарии в стиле доксигена в комментарии Xmldoc Style (стиль документации по умолчанию для Delphi). Эта функция все еще строится и считается экспериментальной.
  • Преобразуйте комментарии в стиль Pasdoc (экспериментальный) : преобразует комментарии в стиле доксигена в комментарии в стиле Pasdoc. Эта функция все еще строится и считается экспериментальной.
• Преобразовать «char» в : тип C char неоднозначен, его можно использовать в качестве 8-битного целого числа или символа в текстовой строке. Типичные версии signed char и unsigned char всегда преобразуются в Shortint и Byte соответственно. Но когда не указано не указано, у вас есть следующие варианты:
  • UTF8CHAR (по умолчанию): преобразовать char в кроссплатформенный UTF8Char .
  • Shortint : преобразовать char в 8-битный подписанный Shortint .
  • Байт : преобразовать char в 8-битный Byte без знака.
• Зарезервированная обработка слов : файлы заголовков могут использовать идентификаторы, которые противоречат зарезервированным словам в Delphi (например, begin и procedure ). Здесь вы указываете, как вы хотите преобразовать эти идентификаторы:
  • Добавьте лидерство '&' (по умолчанию): префикс идентификатор с помощью Ampersand.
  • Добавьте ведущий '_' : префикс идентификатор с подчеркиванием.
  • Добавьте Trailing '_' : добавьте подчеркивание к концу идентификатора.
• Обращаться с директивами как зарезервированными словами : рассматривать ли Delphi Directives как зарезервированные слова (проверено по умолчанию). Технически, вам разрешено использовать многие директивы (такие как public ) в качестве идентификаторов в Delphi, но это выглядит странно, и синтаксис -маркер Delphi относится к ним по -разному. Таким образом, вы обычно хотите относиться и к этим как зарезервированным словам.
• Обработка перечисления : у вас есть возможность преобразовать перечисления C двумя способами:
  • Преобразовать в перечисленный тип (по умолчанию): преобразовать в тип перечисленного Delphi.
  • Преобразовать в тип целочисленного типа и константы : преобразовать имя типа в целое число (как в type MyEnum = Integer; ) и создайте константы для каждой опции в подсчете. Это может быть более применимо для некоторых библиотек.
• Неконвертируемые заявления : Несмотря на все усилия, Чет, возможно, не сможет преобразовать все объявления (особенно #define , см. Замечания ниже). Здесь вы указываете, как справиться с ними:
  • Напишите элемент Todo (по умолчанию): записывает комментарий TODO в исходный код Delphi, а также закомментированную версию оригинального объявления. Помните, что вы можете просмотреть список всех Todo в Delphi IDE, выбрав View | Tool Windows | To-Do List .
  • Прокомментируйте оригинальную декларацию : пишет закомментированную версию оригинального декларации исходному коду Delphi.
  • Игнорируйте декларацию : игнорируют декларацию и ничего не пишите в исходный код Delphi.

Обратите внимание, что только комментарии документации в стиле доксигена анализируются Clang. Это комментарии, которые следуют за любыми из этих конвенций в формате:

• /// 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) */

Чет пытается преобразовать объявления #define в константы, если это возможно. Это работает только если:

• Определение не является функциональным. То есть макросы, такие как #define ABS(x) (x < 0) ? -x : x не может быть переведен.
• Определение использует выражение, которое использует только другие определения и литералы. Например: #define FOO 3<<BAR будет преобразован в const FOO = 3 shl BAR .

Игнорировать страницу

Здесь вы можете указать список символов, чтобы игнорировать. Эти символы не будут переведены.

Наиболее распространенное использование - игнорировать #define , которые генерируют ошибки преобразования или функции, которые вам не нужны. Вы также можете игнорировать некоторые типы, но это может привести к ошибкам компиляции позже, потому что ожидаемые типы отсутствуют.

Обратите внимание, что символы чувствительны к случаям.

Перевод страницы

На последней странице просто есть одна кнопка «Transler Translator» (которую вы также можете активировать с помощью F9 ). Он показывает прогресс процесса перевода, а также любые ошибки, которые произошли при анализе файлов заголовков.

Вы можете использовать эти ошибки для исправления файлов заголовка, добавления файлов отсутствующих заголовков или настройки этого процесса анализа, добавив аргументы командной строки (например, путем добавления путей поиска).

Лицензия

Чет лицензирован по упрощенной лицензии BSD. См. License.txt для деталей.