Chet

Chet - C traducteur d'en-tête pour Delphi

Chet est un traducteur .h-to-.pas alimenté par libclang pour Delphi.

Caractéristiques

Contrairement à certains autres traducteurs d'en-tête, Chet utilise le compilateur Clang pour analyser les fichiers d'en-tête, entraînant des traductions plus précises qui nécessitent moins de réglages manuels.

Certaines fonctionnalités notables sont:

• Trade C Types de données tels que Structs, Union, Enum, typedefs, types de procédure et types opaques.
• Traduit les fonctions C en procédures ou fonctions Delphi.
• Essaie de traduire #define les déclarations dans les constantes dans la mesure du possible.
• Génère un seul fichier .pas pour un répertoire entier de fichiers .h . Cela réduit les problèmes dus aux dépendances entre les fichiers d'en-tête.
• Génère la sortie pour plusieurs plates-formes (Winsows, MacOS, Linux, iOS et Android) si vous le souhaitez.
• Vous pouvez personnaliser le processus d'analyse Clang en fournissant des arguments de ligne de commande au compilateur.
• Vous pouvez personnaliser la sortie de certaines opérations de conversion.
• Conserve tout commentaire de documentation de style Doxygen si vous le souhaitez, ou les convertit en commentaires XMLDOC ou commentaires PASDOC.
• Fournit une interface graphique pour configurer le processus de conversion et vous permet d'enregistrer les paramètres de conversion dans un fichier de projet .chet pour réutiliser.

Limites

• CET fonctionne uniquement avec les fichiers d'en-tête C, et non avec les fichiers d'en-tête C ++.
• Toutes les fonctions non entinées dans les fichiers d'en-tête sont traduites et supposées être disponibles dans la bibliothèque statique ou dynamique du projet. Cela ne doit pas être le cas. (Les fonctions inclinées ne sont jamais traduites car elles ne sont jamais disponibles dans la bibliothèque.)
• Étant donné que Clang est utilisé pour analyser les fichiers d'en-tête, cela signifie que le préprocesseur Clangs est également exécuté pour effectuer l'analyse conditionnelle (guidée par les directives #ifdef ). C'est à la fois bon et mauvais. C'est bien car il améliore la précision de la conversion. Mais cela peut être mauvais car il utilise le système sur lequel CET fonctionne pour déterminer certains chemins conditionnels. Par exemple, parce que CET s'exécute sur Windows, il analyse le code dans les sections #ifdef _WIN32 mais sautera n'importe quel code dans les sections pour d'autres plates-formes.

Exigences

Étant donné que Chet utilise un compilateur réel, vous devrez avoir un environnement (minimal) C de développement installé, ainsi que LLVM avec Clang. Clang doit être en mesure de trouver les en-têtes système pour l'environnement de développement. Ceux-ci seront généralement disponibles si vous avez une version de Visual Studio avec Visual C ++ installé. L'édition gratuite (communautaire) de Visual Studio suffit.

Vous pouvez d'abord exécuter CET pour vérifier les erreurs liées aux dépendances manquantes. Si vous obtenez des erreurs de dépendance lors de l'exécution du traducteur, vous pouvez télécharger les dépendances ici:

• LLVM avec Clang (Clang pour Windows (64 bits) est recommandé).
• Visual Studio IDE (l'édition communautaire gratuite suffit; assurez-vous d'installer le support C ++).

Vous pouvez utiliser l'application Windows CET 64 bits pré-compilée dans le répertoire Bin .

Si vous souhaitez compiler Chet vous-même, vous avez également besoin de libclang pour Delphi et de vous assurer que le Delphi IDE peut le trouver (le projet CHET le trouvera automatiquement si le répertoire Neslib.Clang est au même niveau que le répertoire Chet ).

Contributions

Merci pour ces contributions:

• Michał Sznajder pour améliorer les conversions de char.
• Chiptamer pour ajouter la prise en charge des déclarations de const typées.
• Jarrod Davis pour avoir ajouté un support post-traitement.
• Alexey.t pour ajouter la prise en charge des champs de bits emballés dans C Structs, des mappages de type définis par l'utilisateur et la possibilité d'ignorer certains fichiers d'en-tête.

Guide de l'utilisateur

Chet est assez simple. Dans de nombreux cas, il vous suffit de fournir un répertoire avec des fichiers d'en-tête, le nom du fichier .pas de sortie et sélectionner "Exécuter le traducteur d'en-tête (F9)".

Pour plus de contrôle sur le processus de conversion, vous pouvez spécifier diverses options, décrites ci-dessous.

Menu

Toutes les options de configuration que vous définissez peuvent être enregistrées dans un fichier de configuration .chet (qui est un simple fichier ini). Cela vous permet de charger les paramètres plus tard pour relancer la conversion (par exemple, lorsque de nouvelles versions des fichiers d'en-tête ont été publiées). Vous pouvez charger et enregistrer ces options de configuration à l'aide du menu File .

Pour aider à pré-configurer certains paramètres pour une nouvelle session, sélectionnez File | New Project... (Ctrl+N) . Vous entrez le nom du projet et Chet pré-configurera certains paramètres en fonction du nom que vous entrez (bien que vous puissiez toujours modifier ces paramètres plus tard).

Le menu Run comme le Run Header Translator unique d'option, que vous pouvez également activer avec F9 .

Page du projet

La page du projet contient les options de configuration les plus importantes:

• Répertoire avec C Fichiers d'en-tête : Spécifiez le répertoire avec les fichiers .h Source ici. Le répertoire peut être relatif au répertoire contenant le fichier du projet .chet . Cliquez sur le bouton ... pour parcourir un répertoire. Il est recommandé de ne pas utiliser le répertoire avec le code source C d'origine. Au lieu de cela, copiez les fichiers d'en-tête dans un répertoire distinct uniquement à des fins de conversion. Cela facilite la suppression des fichiers d'en-tête que vous ne souhaitez pas convertir ou pour effectuer des modifications en fichiers d'en-tête à des fins de conversion.
• Incluez les sous-répertoires : cochez cette case si les fichiers d'en-tête sont répartis sur plusieurs répertoires. Dans ce cas, Chet recherchera également toutes les sous-répertoires du répertoire donné.
• Fichier Pascal cible : spécifiez le nom du fichier .pas qui sera généré. I Le fichier Pascal combiné unique sera généré pour tous les fichiers d'en-tête analysés. Le nom peut être relatif au répertoire contenant le fichier du projet .chet . Cliquez sur le bouton ... pour ouvrir une boîte de dialogue Enregistrer.
• Liste d'unité séparée par des virgules à "utiliser" : si les fichiers d'en-tête dépendent des déclarations dans certaines autres unités Delphi (telles que Windows.Winapi ), vous pouvez alors répertorier ces unités ici. Le sera ajouté à la clause d'utilisation du fichier Pascal généré.

Page de plates-formes

Sur cette page, vous spécifiez les plates-formes que vous souhaitez cibler et comment vous souhaitez les configurer.

• Constante de la bibliothèque : spécifiez le nom de la constante à utiliser pour le nom de la bibliothèque. Par exemple, si vous avez une bibliothèque appelée "mylib.dll", le nom de cette constante pourrait être LIB_MYLIB , de sorte que la déclaration suivante sera générée: const LIB_MYLIB = 'mylib.dll' .

Viennent ensuite les cases à cocher pour toutes les plates-formes que vous souhaitez cibler (Windows 32 bits, Windows 64 bits, MacOS 32 bits, Linux 64 bits, iOS et Android). Pour chaque plate-forme que vous vérifiez, vous devez saisir les options suivantes:

• Nom de la bibliothèque : le nom de la bibliothèque dynamique ou statique pour la plate-forme **. **
• Préfixe (_pu) : le préfixe de nom de fonction à utiliser pour la plate-forme. Cela peut généralement être laissé vide. Mais, selon la façon dont la bibliothèque est construite, tous les noms de fonction peuvent être préfixés (généralement avec un caractère de soulignement _ ).

Page d'options d'analyse

Ici, vous pouvez personnaliser le processus d'analyse de clang.

• Ignorez les erreurs d'analyse : cochez cette case pour ignorer les erreurs d'analyse et essayez de traduire les fichiers d'en-tête de toute façon. Notez que cela peut entraîner une sortie incorrecte, vous devez donc généralement laisser ces options sans contrôle. Vous pouvez trouver cette option utile comme option temporaire pour vérifier les erreurs d'analyse. Normalement, Clang arrêtera l'analyse après qu'il rencontre la première erreur mortelle. En cochant cette case, il affichera toutes les erreurs d'analyse (jusqu'à une limite), afin que vous puissiez les aborder et décochez à nouveau cette boîte.
• Arguments de ligne de commande à passer à Clang : Spécifiez tous les arguments de ligne de commande pour passer au compilateur Clang ici. Il n'y a généralement pas besoin de cela, mais certains projets C peuvent nécessiter certains arguments de ligne de commande pour l'analyse pour réussir. Les arguments de ligne de commande les plus courants dont vous pourriez avoir besoin sont d'ajouter des définisseurs de préprocesseur ( -D<define> ) et d'inclure des chemins de recherche ( -I<path> ). Il existe des boutons séparés pour faciliter les ajouter. Reportez-vous à la documentation CLANG pour plus d'informations sur les arguments de ligne de commande disponibles.

Options de conversion

C'est là que vous personnalisez la sortie générée.

• Convention d'appel : spécifiez la convention d'appel à utiliser pour toutes les fonctions traduites. Vous pouvez choisir entre cdecl et stdcall . Dans presque tous les cas, vous devez utiliser la convention d'appel cdecl par défaut. Utilisez stdcall uniquement pour les DLL Windows 32 bits que vous connaissez sont compilées avec la convention d'appel STDCALL. Ce ne sont généralement que les DLL du système Windows. La plupart des DLL tiers utilisent CDECL.
• Gestion des commentaires : ici, vous spécifiez comment gérer les commentaires de documentation (voir également les remarques ci-dessous):
  • Gardez les commentaires en tant que (par défaut): ne convertissez pas les commentaires, mais gardez-les dans leur style d'origine (doxygen).
  • Supprimer les commentaires : Tous les commentaires seront supprimés.
  • Convertir les commentaires en style XMLDOC (expérimental) : convertit les commentaires de style doxygène en commentaires de style XMLDOC (le style de documentation par défaut pour Delphi). Cette fonction est toujours en construction et considérée comme expérimentale.
  • Convertir les commentaires en style PASDOC (expérimental) : convertit les commentaires de style doxygène aux commentaires de style Pasdoc. Cette fonction est toujours en construction et considérée comme expérimentale.
• Convertir "char" en : Le type char C est ambigu, il peut être utilisé comme un entier 8 bits ou un caractère dans une chaîne de texte. Les versions dactylographiées signed char et unsigned char sont toujours converties respectivement en Shortint et Byte . Mais lorsqu'aucune signature n'est spécifiée, vous avez les options suivantes:
  • UTF8CHAR (par défaut): convertir char en une plate-forme multiplateforme UTF8Char .
  • Shortnt : Convertir char en un court-circuit Shortint 8 bits.
  • BYTE : Convertir char en un Byte non signé 8 bits.
• Gestion des mots réservés : les fichiers d'en-tête peuvent utiliser des identificateurs qui entrent en conflit avec les mots réservés à Delphi (comme begin et procedure ). Ici, vous spécifiez comment vous souhaitez convertir ces identifiants:
  • Ajouter le leading '&' (par défaut): préfixer l'identifiant avec un ampère et.
  • Ajouter le principal '_' : préfixer l'identifiant avec un soulignement.
  • Ajouter la fuite '_' : Ajoutez un soulignement à la fin de l'identifiant.
• Traitez les directives comme des mots réservés : s'il faut traiter les directives de Delphi comme des mots réservés (vérifié par défaut). Techniquement, vous êtes autorisé à utiliser de nombreuses directives (comme public ) comme des identifiants à Delphi, mais il a l'air étrange et le surligneur de la syntaxe de Delphi les traite différemment. Vous voulez donc généralement les traiter comme des mots réservés.
• Manipulation de l'énumération : vous avez la possibilité de convertir les énumérations C de deux manières:
  • Convertir en type énuméré (par défaut): converti en un type énuméré delphi.
  • Convertir en type entier et constantes : convertissez le nom de type lui-même en un entier (comme dans type MyEnum = Integer; ) et créez des constantes pour chaque option dans l'énumération. Cela peut être plus applicable à certaines bibliothèques.
• Déclarations invitables : Malgré les meilleurs efforts, Chet peut ne pas être en mesure de convertir toutes les déclarations (en particulier #define 's, voir les remarques ci-dessous). Ici, vous spécifiez comment les gérer:
  • Écrivez l'élément TODO (par défaut): écrit un commentaire TODO au code source de Delphi, ainsi qu'une version commentée de la déclaration d'origine. N'oubliez pas que vous pouvez afficher une liste de tous les TODO dans l'IDE Delphi en sélectionnant View | Tool Windows | To-Do List .
  • Commentez la déclaration originale : écrit une version commentée de la déclaration originale au code source de Delphi.
  • Ignorez la déclaration : ignore la déclaration et n'écrit rien au code source de Delphi.

Notez que seuls les commentaires de documentation de style Doxygen sont analysés par Clang. Ce sont des commentaires qui suivent l'une de ces conventions de format:

• /// 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 essaie de convertir les déclarations #define en constantes si possible. Cela ne fonctionne que si:

• La définition ne ressemble pas à une fonction. C'est-à-dire des macros comme #define ABS(x) (x < 0) ? -x : x ne peut pas être traduit.
• Le Define utilise une expression qui n'utilise que d'autres définies et littéraux. Par exemple: #define FOO 3<<BAR sera converti en const FOO = 3 shl BAR .

Ignorer la page

Ici, vous pouvez spécifier une liste de symboles à ignorer. Ces symboles ne seront pas traduits.

L'utilisation la plus courante consiste à ignorer #define qui génèrent des erreurs de conversion ou des fonctions dont vous n'avez pas besoin. Vous pouvez également choisir d'ignorer certains types, mais cela peut entraîner des erreurs de compilation plus tard car les types attendus sont manquants.

Notez que les symboles sont sensibles à la casse.

Page de traduire

La page finale a juste un seul bouton "Exécuter le traducteur d'en-tête" (que vous pouvez également activer avec F9 ). Il montre la progression du processus de traduction, ainsi que toutes les erreurs qui se sont produites lors de l'analyse des fichiers d'en-tête.

Vous pouvez utiliser ces erreurs pour corriger les fichiers d'en-tête, ajouter des fichiers d'en-tête manquants ou configurer ce processus d'analyse en ajoutant des arguments de ligne de commande (par exemple, en ajoutant des chemins de recherche incluent).

Licence

CET est autorisé sous la licence BSD simplifiée. Voir Licence.txt pour plus de détails.