Chet

CHET - C -Headerübersetzer für Delphi

CHET ist ein .h-to-.pas -Übersetzer von Libclang für Delphi.

Merkmale

Im Gegensatz zu einigen anderen Header -Übersetzern verwendet Chet den Klang -Compiler, um Header -Dateien zu analysieren, was zu genaueren Übersetzungen führt, die weniger manuelle Anpassungen erfordern.

Einige bemerkenswerte Funktionen sind:

• Übersetzt C -Datentypen wie Strukturen, Gewerkschaft, Enums, Typedefs, Verfahrenstypen und undurchsichtige Typen.
• Übersetzt C -Funktionen in Delphi -Prozeduren oder -funktionen.
• Versucht, #define Erklärungen in Konstanten nach Möglichkeit zu übersetzen.
• Generiert eine einzelne .pas -Datei für ein ganzes Verzeichnis von .h -Dateien. Dies reduziert die Probleme aufgrund von Abhängigkeiten zwischen Header -Dateien.
• Erzeugt die Ausgabe für mehrere Plattformen (Winsows, MacOS, Linux, iOS und Android), falls gewünscht.
• Sie können den Clang -Parsing -Prozess anpassen, indem Sie den Compiler Befehlszeilenargumente zur Verfügung stellen.
• Sie können die Ausgabe einiger Konvertierungsvorgänge anpassen.
• Behält bei gewünschter Dokumentation Kommentare im Doxygen -Stil bei oder konvertiert sie in XMLDOC -Kommentare oder Pasdoc -Kommentare.
• Bietet eine GUI für die Konfiguration des Konvertierungsprozesses und ermöglicht es Ihnen, die Conversion -Einstellungen in einer .chet -Projektdatei zur Wiederverwendung zu speichern.

Einschränkungen

• CHET funktioniert nur mit C -Header -Dateien, nicht mit C ++ - Header -Dateien.
• Alle nicht in den Header-Dateien nicht eingestellten Funktionen werden übersetzt und werden in der statischen oder dynamischen Bibliothek für das Projekt verfügbar sein. Dies muss nicht der Fall sein. (Eingebrachte Funktionen werden nie übersetzt, da sie in der Bibliothek nie verfügbar sind.)
• Da Clang verwendet wird, um die Header -Dateien zu analysieren, bedeutet dies, dass Clangs -Präprozessor auch ausgeführt wird, um eine bedingte Parsen durchzuführen (geführt von #ifdef -Anweisungen). Das ist sowohl gut als auch schlecht. Es ist gut, weil es die Conversion -Genauigkeit verbessert. Es kann jedoch schlecht sein, weil das System, auf dem Chet ausgeführt wird, einige bedingte Pfade zu bestimmen. Da Chet beispielsweise unter Windows ausgeführt wird, wird Code in #ifdef _WIN32 -Abschnitten analysiert, überspringt jedoch jeden Code in Abschnitten für andere Plattformen.

Anforderungen

Da Chet einen tatsächlichen Compiler verwendet, müssen Sie eine (minimale) C -Entwicklungsumgebung sowie LLVM mit Clang installiert haben. Clang muss in der Lage sein, die Systemheader für die Entwicklungsumgebung zu finden. Diese sind normalerweise verfügbar, wenn Sie eine Version von Visual Studio mit Visual C ++ installiert haben. Die kostenlose (Community) Edition von Visual Studio reicht aus.

Sie können zuerst Chet ausführen, um alle Fehler in Bezug auf fehlende Abhängigkeiten zu überprüfen. Wenn Sie beim Ausführen des Übersetzers Abhängigkeitsfehler erhalten, können Sie die Abhängigkeiten hier herunterladen:

• LLVM mit Clang (Clang für Fenster (64-Bit) wird empfohlen).
• Visual Studio IDE (die kostenlose Community Edition genügt; achten Sie darauf, dass Sie C ++ Support installieren).

Sie können die vorkompilierte 64-Bit-Windows-Chet-Anwendung im Bin Verzeichnis verwenden.

Wenn Sie Chet selbst kompilieren möchten, benötigen Sie auch Libclang für Delphi und stellen Sie sicher, dass die Delphi -IDE es finden kann (das Chet -Projekt findet es automatisch, wenn das Verzeichnis Neslib.Clang auf dem gleichen Niveau wie das Chet -Verzeichnis liegt).

Beiträge

Vielen Dank für diese Beiträge:

• Michał Sznajder für verbesserte Char -Conversions.
• Chiptamer zum Hinzufügen von Unterstützung für typisierte Const -Deklarationen.
• Jarrod Davis für das Hinzufügen von Unterstützung nach der Verarbeitung.
• Alexey.t zum Hinzufügen von Unterstützung für verpackte Bitfelder in C-Strukturen, benutzerdefinierten Typ-Zuordnungen und der Möglichkeit, bestimmte Header-Dateien zu ignorieren.

Benutzerhandbuch

Chet ist ziemlich einfach. In vielen Fällen müssen Sie nur ein Verzeichnis mit Header -Dateien, dem Namen der Ausgabe .pas -Datei, angeben und "Header -Übersetzer ausführen (F9) ausführen".

Für mehr Kontrolle über den Konvertierungsprozess können Sie verschiedene Optionen angeben, die unten beschrieben werden.

Speisekarte

Alle von Ihnen festgelegten Konfigurationsoptionen können in einer .chet Konfigurationsdatei (eine einfache Ini-Datei) gespeichert werden. Auf diese Weise können Sie die Einstellungen später laden, um die Konvertierung erneut auszusetzen (z. B. wenn neue Versionen der Header -Dateien veröffentlicht wurden). Sie können diese Konfigurationsoptionen mit dem Menü File laden und speichern.

Um einige Einstellungen für eine neue Sitzung vorzubeugen, wählen Sie File | New Project... (Ctrl+N) . Sie geben den Namen des Projekts ein, und Chet konfigurieren einige Einstellungen basierend auf dem von Ihnen eingegebenen Namen (obwohl Sie diese Einstellungen später jederzeit ändern können).

Das Run von Menü genau wie der einzelne Options Run Header Translator , den Sie auch mit F9 aktivieren können.

Projektseite

Die Projektseite enthält die wichtigsten Konfigurationsoptionen:

• Verzeichnis mit C -Header -Dateien : Geben Sie das Verzeichnis hier mit den Quell .h -Dateien an. Das Verzeichnis kann relativ zum Verzeichnis sein, das die .chet -Projektdatei enthält. Klicken Sie auf die Schaltfläche ... , um nach einem Verzeichnis zu durchsuchen. Es wird empfohlen, das Verzeichnis nicht mit dem ursprünglichen C -Quellcode zu verwenden. Kopieren Sie stattdessen die Header -Dateien in ein separates Verzeichnis nur für Konvertierungszwecke. Dies erleichtert das Löschen von Header -Dateien, die Sie nicht konvertieren möchten, oder um Änderungen an Header -Dateien für Konvertierungszwecke vorzunehmen.
• Subdirektorien einschließen : Aktivieren Sie dieses Kontrollkästchen, wenn die Header -Dateien über mehrere Verzeichnisse verteilt sind. In diesem Fall wird Chet auch alle Unterverzeichnisse des angegebenen Verzeichnisses durchsuchen.
• Zielpascal -Datei : Geben Sie den Namen der .pas -Datei an, die generiert wird. I Single Combined Pascal -Datei wird für alle Parsen -Header -Dateien generiert. Der Name kann relativ zum Verzeichnis sein, das die .chet -Projektdatei enthält. Klicken Sie auf die Schaltfläche ... , um ein Dialogfeld Speichern zu öffnen.
• Komma getrennte Liste von "Verwenden" : Wenn die Header-Dateien in einigen anderen Delphi-Einheiten (wie Windows.Winapi ) von Deklarationen abhängen, können Sie diese Einheiten hier auflisten. Die Verwendungsklausel der generierten Pascal -Datei wird hinzugefügt.

Plattformen Seite

Auf dieser Seite geben Sie an, welche Plattformen Sie abzielen möchten und wie Sie sie konfigurieren möchten.

• Bibliothekskonstante : Geben Sie den Namen der Konstante an, die für den Namen der Bibliothek verwendet werden soll. Wenn Sie beispielsweise eine Bibliothek namens "Mylib.dll" haben, kann der Name dieser Konstante LIB_MYLIB sein, sodass die folgende Deklaration generiert wird: const LIB_MYLIB = 'mylib.dll' .

Als nächstes stehen Kontrollkästchen für alle Plattformen, die Sie zielen möchten (32-Bit-Windows, 64-Bit-Windows, 32-Bit-MacOS, 64-Bit-Linux, iOS und Android). Für jede Plattform, die Sie überprüfen, müssen Sie die folgenden Optionen eingeben:

• Bibliotheksname : Der Name der dynamischen oder statischen Bibliothek für die Plattform **. **
• Präfix (_PU) : Das Präfix des Funktionsnamens, das für die Plattform verwendet werden soll. Dies kann normalerweise leer bleiben. Je nachdem, wie die Bibliothek erstellt wird, können alle Funktionsnamen vorangestellt werden (normalerweise mit einem Unterstrich _ -Zeichen).

Optionen analysieren

Hier können Sie den Clang -Parsing -Prozess anpassen.

• Analysefehler ignorieren : Aktivieren Sie dieses Kontrollkästchen, um alle Parsenfehler zu ignorieren, und versuchen Sie, die Header -Dateien trotzdem zu übersetzen. Beachten Sie, dass dies zu einer falschen Ausgabe führen kann, sodass Sie diese Optionen im Allgemeinen deaktiviert lassen. Möglicherweise finden Sie diese Option als vorübergehende Option, um nach Analysefehlern zu überprüfen. Normalerweise hört Clang auf zu analysieren, nachdem er auf den ersten tödlichen Fehler trifft. Wenn Sie dieses Kontrollkästchen überprüfen, werden alle Parsenfehler angezeigt (bis zu einem Grenzwert), sodass Sie diese ansprechen und dieses Feld dann erneut deaktivieren können.
• Befehlszeilenargumente zum Übergeben an Clang : Geben Sie alle Befehlszeilenargumente an, um hier an den Clang -Compiler weiterzugeben. Dies besteht normalerweise nicht erforderlich, aber einige C -Projekte erfordern möglicherweise einige Befehlszeilenargumente, damit analysiert werden soll, um erfolgreich zu sein. Die häufigsten Argumente für die Befehlszeilen, die Sie möglicherweise benötigen, ist das Hinzufügen von Präprozessor -Definierungen ( -D<define> ) und die Suchpfade ( -I<path> ) einschließen. Es gibt separate Schaltflächen, mit denen diese einfacher hinzugefügt werden können. Informationen zu den verfügbaren Befehlszeilenargumenten der Clang finden Sie in der Clang -Dokumentation.

Conversion -Optionen

Hier passen Sie die generierte Ausgabe an.

• Anrufen von Konvention : Geben Sie die aufgerufene Konvention an, die für alle übersetzten Funktionen verwendet werden soll. Sie können zwischen cdecl und stdcall wählen. In fast allen Fällen sollten Sie die Standard cdecl -Konvention verwenden. Verwenden Sie stdcall nur für 32-Bit-Windows-DLLs, von denen Sie wissen, dass sie mit der STDCALL-Aufrufkonvention zusammengestellt werden. Dies sind normalerweise nur Windows -System -DLLs. Die meisten DLL -CDEC -Nutzung der dritten Party.
• Kommentarbearbeitung : Hier geben Sie an, wie Sie mit Dokumentationskommentaren umgehen (siehe auch Anmerkungen unten):
  • Behalten Sie Kommentare als IS (Standard) auf: Konvertieren Sie die Kommentare nicht, sondern halten Sie sie im ursprünglichen (Doxygen-) Stil.
  • Kommentare entfernen : Alle Kommentare werden entfernt.
  • Konvertieren Sie Kommentare in den XMLDOC-Stil (experimentell) : Konvertiert Kommentare im Doxygen-Stil in Kommentare im XMLDOC-Stil (der Standarddokumentationsstil für Delphi). Dieses Merkmal befindet sich noch im Konstruktion und wird als experimentell angesehen.
  • Konvertieren Sie Kommentare in den Pasdoc-Stil (experimentell) : Konvertiert Kommentare im Doxygen-Stil in Kommentare im Pasdoc-Stil. Dieses Merkmal befindet sich noch im Konstruktion und wird als experimentell angesehen.
• Konvertieren Sie "char" in : Der C- char Typ ist mehrdeutig, er kann als 8-Bit-Ganzzahl oder Zeichen in einer Textzeichenfolge verwendet werden. Die typisierten Versionen signed char und unsigned char werden immer in Shortint bzw. Byte umgewandelt. Wenn jedoch keine Unterzeichnungsness angegeben ist, haben Sie die folgenden Optionen:
  • UTF8CHAR (Standard): char in einen plattformübergreifenden UTF8Char konvertieren.
  • Shortint : char in einen 8-Bit-Shortint- Shortint umwandeln.
  • Byte : char in ein 8-Bit Byte konvertieren.
• Reservierte Word -Handhabung : Header -Dateien können Kennungen verwenden, die mit zurückhaltenden Wörtern in Delphi (z. B. begin und procedure ) in Konflikt stehen. Hier geben Sie an, wie Sie diese Kennungen konvertieren möchten:
  • Fügen Sie das Leading '&' (Standard) hinzu: Präfix die Kennung mit einem Ampers und.
  • Fügen Sie das führende "_" hinzu : Präfix die Kennung mit einem Unterstrich.
  • Fügen Sie nachverfolgung '_' hinzu : Fügen Sie dem Ende der Kennung einen Unterstrich hinzu.
• Behandle Richtlinien als reservierte Wörter : Ob Delphi -Richtlinien auch als reservierte Wörter behandelt werden (standardmäßig überprüft). Technisch gesehen dürfen Sie viele Richtlinien (wie public ) als Kennungen in Delphi verwenden, aber es sieht seltsam aus und Delphis Syntax Highlighter behandelt sie anders. Sie möchten diese also normalerweise auch als reservierte Wörter behandeln.
• Enum -Handling : Sie haben die Möglichkeit, C -Enums auf zwei Arten umzuwandeln:
  • Konvertieren Sie in den aufzähligen Typ (Standard): Konvertieren Sie sie in einen delphi aufzähligen Typ.
  • Konvertieren Sie in Ganzzahltyp und Konstanten : Konvertieren Sie den Typennamen selbst in eine Ganzzahl (wie in type MyEnum = Integer; ) und erstellen Sie Konstanten für jede Option in der Aufzählung. Dies kann für einige Bibliotheken eher anwendbar sein.
• Unkonvertierbare Erklärungen : Trotz der besten Anstrengungen ist Chet möglicherweise nicht in der Lage, alle Erklärungen zu konvertieren (insbesondere #define 's, siehe Anmerkungen unten). Hier geben Sie an, wie Sie mit diesen umgehen:
  • Schreiben Sie das TODO-Element (Standard): schreibt einen TODO Kommentar in den Delphi-Quellcode sowie eine kommentierte Version der ursprünglichen Deklaration. Denken Sie daran, dass Sie eine Liste aller Todo in der Delphi -IDE anzeigen können, indem Sie View | Tool Windows | To-Do List .
  • Kommentieren Sie die Originalerklärung : schreibt eine kommentierte Version der ursprünglichen Erklärung in den Delphi-Quellcode.
  • Deklaration ignorieren : Ignoriert die Erklärung und schreibt nichts in den Delphi -Quellcode.

Beachten Sie, dass nur Doxygen -Dokumentation Kommentare von Clang analysiert werden. Dies sind Kommentare, die einer dieser Formatkonventionen folgen:

• /// 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 versucht, #define Deklarationen in Konstanten zu konvertieren, wenn möglich. Dies funktioniert nur, wenn:

• Der Define ist nicht funktionsartig. Das heißt, Makros mögen #define ABS(x) (x < 0) ? -x : x kann nicht übersetzt werden.
• Der Define verwendet einen Ausdruck, der nur andere Definierungen und Literale verwendet. Zum Beispiel: #define FOO 3<<BAR wird in const FOO = 3 shl BAR umgewandelt.

Seite ignorieren

Hier können Sie eine Liste von Symbolen angeben, die Sie ignorieren sollen. Diese Symbole werden nicht übersetzt.

Die häufigste Verwendung besteht darin, #define 's zu ignorieren, die Konvertierungsfehler oder Funktionen generieren, die Sie nicht benötigen. Sie können auch einige Typen ignorieren, dies kann jedoch später zu Kompilierungsfehlern führen, da erwartete Typen fehlen.

Beachten Sie, dass Symbole Fallempfindlichkeit sind.

Seite übersetzen

Auf der letzten Seite verfügt nur eine einzige Taste "Header -Übersetzer ausführen" (die Sie auch mit F9 aktivieren können). Es zeigt den Fortschritt des Übersetzungsprozesses sowie alle Fehler, die beim Parsen der Header -Dateien aufgetreten sind.

Sie können diese Fehler verwenden, um die Header -Dateien zu beheben, fehlende Header -Dateien hinzuzufügen oder diesen Parsenprozess durch Hinzufügen von Befehlszeilenargumenten zu konfigurieren (beispielsweise durch Hinzufügen von Include -Suchpfaden).

Lizenz

Chet ist unter der vereinfachten BSD -Lizenz lizenziert. Einzelheiten siehe Lizenz.txt.