Chet

Chet - C traductor de encabezado para Delphi

Chet es un traductor .h-to-.pas alimentado por libclang para Delphi.

Características

A diferencia de otros traductores de encabezado, Chet usa el compilador Clang para analizar archivos de encabezado, lo que resulta en traducciones más precisas que requieren menos ajustes manuales.

Algunas características notables son:

• Traduce los tipos de datos C, como estructuras, unión, enums, typedefs, tipos de procedimiento y tipos opacos.
• Traduce las funciones C a los procedimientos o funciones de Delphi.
• Intenta traducir #define declaraciones a constantes cuando sea posible.
• Genera un solo archivo .pas para un directorio completo de archivos .h . Esto reduce los problemas debido a las dependencias entre los archivos de encabezado.
• Genera salida para múltiples plataformas (WINSOWS, MACOS, LINUX, iOS y Android) si lo desea.
• Puede personalizar el proceso de análisis de Clang suministrando argumentos de línea de comandos al compilador.
• Puede personalizar la salida de algunas operaciones de conversión.
• Conserva cualquier comentario de documentación de estilo Doxygen si lo desea, o los convierte en comentarios de XMLDOC o comentarios de PasDOC.
• Proporciona una GUI para configurar el proceso de conversión y le permite guardar la configuración de conversión en un archivo de proyecto .chet para reutilizar.

Limitaciones

• Chet solo funciona con archivos de encabezado C, no con archivos de encabezado C ++.
• Todas las funciones no en línea en los archivos de encabezado se traducen y se supone que están disponibles en la biblioteca estática o dinámica para el proyecto. Este no tiene que ser el caso. (Las funciones en línea nunca se traducen ya que nunca están disponibles en la biblioteca).
• Dado que Clang se usa para analizar los archivos de encabezado, esto significa que el preprocesador de Clangs también se ejecuta para realizar un análisis condicional (guiado por las directivas #ifdef ). Esto es bueno y malo. Es bueno porque mejora la precisión de la conversión. Pero puede ser malo porque utiliza el sistema en el que CHET se ejecuta para determinar algunas rutas condicionales. Por ejemplo, debido a que Chet se ejecuta en Windows, analizará el código en las secciones #ifdef _WIN32 pero omita cualquier código en las secciones para otras plataformas.

Requisitos

Dado que CHET utiliza un compilador real, deberá tener un entorno de desarrollo C (mínimo) instalado, así como LLVM con Clang. Clang necesita poder encontrar los encabezados del sistema para el entorno de desarrollo. Por lo general, estarán disponibles si tiene alguna versión de Visual Studio con Visual C ++ instalada. La edición gratuita (comunidad) de Visual Studio es suficiente.

Primero puede ejecutar CHET para verificar cualquier error relacionado con las dependencias faltantes. Si recibe algún error de dependencia al ejecutar el traductor, puede descargar las dependencias aquí:

• Se recomienda LLVM con Clang (rango para ventanas (64 bits)).
• Visual Studio IDE (la edición comunitaria gratuita es suficiente; asegúrese de instalar soporte C ++).

Puede usar la aplicación Windows Chet de 64 bits precompilada en el directorio Bin .

Si desea compilar chet, también necesita libclang para Delphi y asegúrese de que el IDE Delphi pueda encontrarlo (el proyecto CHET lo encontrará automáticamente si el directorio Neslib.Clang está al mismo nivel que el directorio Chet ).

Contribuciones

Gracias por estas contribuciones:

• Michał Sznajder para mejorar las conversiones de char.
• Chiptamer para agregar soporte para declaraciones de const tipificadas.
• Jarrod Davis por agregar soporte de postprocesamiento.
• Alexey.t para agregar soporte para campos de bits empaquetados en estructuras C, asignaciones de tipo definidas por el usuario y la capacidad de ignorar ciertos archivos de encabezado.

Guía del usuario

Chet es bastante sencillo. En muchos casos, solo necesita proporcionar un directorio con archivos de encabezado, el nombre del archivo .pas de salida y seleccionar "Ejecutar el traductor de encabezado (F9)".

Para obtener más control sobre el proceso de conversión, puede especificar varias opciones, descritas a continuación.

Menú

Cualquier opción de configuración que establezca se puede guardar en un archivo de configuración .chet (que es un simple archivo). Esto le permite cargar la configuración más tarde para volver a ejecutar la conversión (por ejemplo, cuando se han lanzado nuevas versiones de los archivos de encabezado). Puede cargar y guardar estas opciones de configuración utilizando el menú File .

Para ayudar a preconfigurar algunas configuraciones para una nueva sesión, seleccione File | New Project... (Ctrl+N) . Ingrese el nombre del proyecto y CHET preconfigurará algunas configuraciones en función del nombre que ingrese (aunque siempre puede modificar esa configuración más adelante).

El menú Run al igual que la opción única Run Header Translator , que también puede activar con F9 .

Página del proyecto

La página del proyecto contiene las opciones de configuración más importantes:

• Directorio con archivos de encabezado C : Especifique el directorio con los archivos .h de origen aquí. El directorio puede ser relativo al directorio que contiene el archivo del proyecto .chet . Haga clic en el botón ... para buscar un directorio. Se recomienda que no use el directorio con el código fuente C original. En su lugar, copie los archivos de encabezado en un directorio separado solo para fines de conversión. Esto hace que sea más fácil eliminar archivos de encabezado que no desea convertir, o hacer ediciones a archivos de encabezado para fines de conversión.
• Incluya subdirectorios : marque esta casilla si los archivos de encabezado se extienden a través de múltiples directorios. En ese caso, Chet también buscará todos los subdirectorios del directorio dado.
• Archivo objetivo Pascal : especifique el nombre del archivo .pas que se generará. Se generará un archivo Pascal combinado único para todos los archivos de encabezado analizados. El nombre puede ser relativo al directorio que contiene el archivo del proyecto .chet . Haga clic en el botón ... para abrir un cuadro de diálogo Guardar.
• Lista de unidad separada por comas para "usar" : si los archivos de encabezado dependen de las declaraciones en otras unidades de Delphi (como Windows.Winapi ), entonces puede enumerar esas unidades aquí. Se agregará a la cláusula de usos del archivo PASCAL generado.

Página de plataformas

En esta página, especifica qué plataformas desea orientar y cómo desea configurarlas.

• Biblioteca constante : especifique el nombre de la constante para usar para el nombre de la biblioteca. Por ejemplo, si tiene una biblioteca llamada "mylib.dll", entonces el nombre de esta constante podría ser LIB_MYLIB , por lo que se generará la siguiente declaración: const LIB_MYLIB = 'mylib.dll' .

Las siguientes son las casillas de verificación para todas las plataformas a las que desea apuntar (Windows de 32 bits, Windows de 64 bits, macOS de 32 bits, Linux de 64 bits, iOS y Android). Para cada plataforma que verifica, debe ingresar las siguientes opciones:

• Nombre de la biblioteca : el nombre de la biblioteca dinámica o estática para la plataforma **. **
• Prefijo (_pu) : el prefijo de nombre de la función para usar para la plataforma. Esto generalmente se puede dejar vacío. Pero, dependiendo de cómo se construya la biblioteca, todos los nombres de funciones pueden estar prefijados (generalmente con un carácter inferior _ ).

Página de opciones de análisis

Aquí puede personalizar el proceso de análisis de Clang.

• Ignore los errores de análisis : marque esta casilla para ignorar cualquier error de análisis e intente traducir los archivos de encabezado de todos modos. Tenga en cuenta que esto puede conducir a una salida incorrecta, por lo que generalmente debe dejar estas opciones sin control. Puede encontrar esta opción útil como una opción temporal para verificar los errores de análisis. Normalmente, Clang dejará de analizar después de que encuentre el primer error fatal. Al revisar este cuadro, mostrará todos los errores de análisis (hasta un límite), por lo que puede abordarlos y luego desmarcar esta casilla nuevamente.
• Argumentos de línea de comandos para pasar a CLANG : especifique cualquier argumento de línea de comando para pasar al compilador Clang aquí. Por lo general, no hay necesidad de esto, pero algunos proyectos C pueden requerir algunos argumentos de línea de comandos para que el análisis tenga éxito. Los argumentos de línea de comandos más comunes que puede necesitar son agregar el preprocesador define ( -D<define> ) e incluyen rutas de búsqueda ( -I<path> ). Hay botones separados para que sea más fácil agregarlos. Consulte la documentación de Clang para obtener información sobre los argumentos de línea de comandos disponibles.

Opciones de conversión

Aquí es donde personaliza la salida generada.

• Convención de llamadas : especifique la convención de llamadas para usar para todas las funciones traducidas. Puede elegir entre cdecl y stdcall . En casi todos los casos, debe usar la convención predeterminada de llamadas cdecl . Use stdcall solo para los DLL de Windows de 32 bits que sabe que se compilan con la convención de llamadas STDCall. Esos son solo solo DLL del sistema de Windows. La mayoría de los terceros dll usan CDECL.
• Manejo de comentarios : aquí especifica cómo manejar los comentarios de la documentación (ver también los comentarios a continuación):
  • Mantenga los comentarios como está (predeterminado): no convierta los comentarios, pero manténgalos en su estilo original (doxygen).
  • Eliminar comentarios : todos los comentarios se eliminarán.
  • Convierta los comentarios en el estilo XMLDOC (experimental) : convierte los comentarios de estilo Doxygen en comentarios de estilo XMLDOC (el estilo de documentación predeterminado para Delphi). Esta característica todavía está en construcción y se considera experimental.
  • Convertir comentarios al estilo PasDOC (experimental) : convierte los comentarios de estilo Doxygen en comentarios de estilo PasDOC. Esta característica todavía está en construcción y se considera experimental.
• Convertir "Char" a : El tipo C char es ambiguo, se puede usar como un entero de 8 bits o un carácter en una cadena de texto. Las versiones mecanografiadas signed char y unsigned char siempre se convierten en Shortint y Byte respectivamente. Pero cuando no se especifica la firma, tiene las siguientes opciones:
  • UTF8CHAR (predeterminado): Convertir char a un UTF8Char de plataforma cruzada.
  • Shortint : Convertir char a un Shortint firmado de 8 bits.
  • BYTE : Convertir char a un Byte sin firmar de 8 bits.
• Manejo de palabras reservado : los archivos de encabezado pueden usar identificadores que entran en conflicto con palabras reservadas en Delphi (como begin y procedure ). Aquí especifica cómo desea convertir estos identificadores:
  • Agregue liderazgo '&' (predeterminado): prefijo el identificador con un ampersand.
  • Agregue '_' liderante : prefijo el identificador con un bajo.
  • Agregue el final '_' : Agregue un subrayador al final del identificador.
• Trate las directivas como palabras reservadas : si también tratar las directivas de Delphi como palabras reservadas (verificadas por defecto). Técnicamente, se le permite usar muchas directivas (como public ) como identificadores en Delphi, pero se ve extraño y el marcador de sintaxis de Delphi los trata de manera diferente. Por lo tanto, generalmente también desea tratarlos como palabras reservadas.
• Manejo de enum : tiene la opción de convertir los enumnos C de dos maneras:
  • Convertir al tipo enumerado (predeterminado): Convertir a un tipo enumerado Delphi.
  • Convierta a tipo entero y constantes : convierta el nombre de tipo en un entero (como en type MyEnum = Integer; ) y cree constantes para cada opción en la enumeración. Esto puede ser más aplicable para algunas bibliotecas.
• Declaraciones inconvertibles : a pesar de los mejores esfuerzos, Chet puede no ser capaz de convertir todas las declaraciones (especialmente #define ", vea los comentarios a continuación). Aquí especifica cómo manejar estos:
  • Escriba el elemento TODO (predeterminado): escribe un comentario TODO al código fuente de Delphi, así como una versión comentada de la declaración original. Recuerde que puede ver una lista de todos los TODO en Delphi IDE seleccionando View | Tool Windows | To-Do List .
  • Comentario Declaración original : escribe una versión comentada de la declaración original al código fuente de Delphi.
  • Ignorar la declaración : ignora la declaración y no escribe nada al código fuente de Delphi.

Tenga en cuenta que solo los comentarios de documentación de estilo Doxygen están analizados por Clang. Estos son comentarios que siguen cualquiera de estas convenciones de formato:

• /// 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 intenta convertir las declaraciones #define a constantes si es posible. Esto solo funciona si:

• La definición no es como la función. Es decir, macros como #define ABS(x) (x < 0) ? -x : x no se puede traducir.
• La definición usa una expresión que solo usa otras define y literales. Por ejemplo: #define FOO 3<<BAR se convertirá a const FOO = 3 shl BAR .

Ignorar la página

Aquí puede especificar una lista de símbolos para ignorar. Estos símbolos no serán traducidos.

El uso más común es ignorar los #define que generan errores de conversión o funciones que no necesita. También puede optar por ignorar algunos tipos, pero eso puede dar lugar a errores de compilación más adelante porque faltan los tipos esperados.

Tenga en cuenta que los símbolos son sensibles a los casos.

Página de traducción

La página final solo tiene un solo botón "Ejecutar el traductor de encabezado" (que también puede activar con F9 ). Muestra el progreso del proceso de traducción, así como cualquier error que ocurriera mientras analizaba los archivos de encabezado.

Puede usar estos errores para corregir los archivos de encabezado, agregar archivos de encabezado faltantes o configurar ese proceso de análisis agregando argumentos de línea de comandos (por ejemplo, agregando rutas de búsqueda de incluido).

Licencia

Chet tiene licencia bajo la licencia BSD simplificada. Consulte License.txt para más detalles.