Chet

Chet - C Header Translator untuk Delphi

Chet adalah penerjemah .h-to-.pas yang ditenagai oleh LibClang untuk Delphi.

Fitur

Tidak seperti beberapa penerjemah header lainnya, Chet menggunakan compiler dentang untuk parse header file, menghasilkan terjemahan yang lebih akurat yang membutuhkan lebih sedikit penyesuaian manual.

Beberapa fitur penting adalah:

• Menerjemahkan tipe data C seperti struct, persatuan, enum, typedef, tipe prosedural dan tipe buram.
• Menerjemahkan fungsi C ke prosedur atau fungsi Delphi.
• Mencoba menerjemahkan #define Declarations ke konstanta jika memungkinkan.
• Menghasilkan satu file .pas untuk seluruh direktori file .h . Ini mengurangi masalah karena ketergantungan antara file header.
• Menghasilkan output untuk beberapa platform (Winsows, MacOS, Linux, IOS dan Android) jika diinginkan.
• Anda dapat menyesuaikan proses parsing dentang dengan memasok argumen baris perintah ke kompiler.
• Anda dapat menyesuaikan output dari beberapa operasi konversi.
• Mempertahankan komentar dokumentasi gaya doxygen jika diinginkan, atau mengubahnya menjadi komentar xmldoc atau komentar pasdoc.
• Menyediakan GUI untuk mengkonfigurasi proses konversi, dan memungkinkan Anda menyimpan pengaturan konversi ke file proyek .chet untuk digunakan kembali.

Batasan

• Chet hanya berfungsi dengan file header C, bukan dengan file header C ++.
• Semua fungsi non-inline dalam file header diterjemahkan dan diasumsikan tersedia di pustaka statis atau dinamis untuk proyek tersebut. Ini tidak harus menjadi masalahnya. (Fungsi inline tidak pernah diterjemahkan karena tidak pernah tersedia di perpustakaan.)
• Karena dentang digunakan untuk menguraikan file header, ini berarti bahwa clangs preprocessor dijalankan juga untuk melakukan penguraian bersyarat (dipandu oleh arahan #ifdef ). Ini baik dan buruk. Itu bagus karena meningkatkan akurasi konversi. Tapi itu bisa buruk karena menggunakan sistem yang dijalankan Chet untuk menentukan beberapa jalur bersyarat. Misalnya, karena Chet berjalan pada Windows, itu akan menguraikan kode di bagian #ifdef _WIN32 tetapi melewatkan kode apa pun di bagian untuk platform lain.

Persyaratan

Karena Chet menggunakan kompiler yang sebenarnya, Anda harus memiliki lingkungan (minimal) C yang berkembang yang dipasang, serta LLVM dengan dentang. Dentang harus dapat menemukan header sistem untuk lingkungan pengembangan. Ini biasanya akan tersedia jika Anda memiliki beberapa versi Visual Studio dengan Visual C ++ diinstal. Edisi (komunitas) Visual Studio cukup.

Anda dapat menjalankan Chet terlebih dahulu untuk memeriksa kesalahan apa pun yang terkait dengan dependensi yang hilang. Jika Anda mendapatkan kesalahan ketergantungan saat menjalankan penerjemah, maka Anda dapat mengunduh dependensi di sini:

• LLVM dengan dentang (dentang untuk windows (64-bit) direkomendasikan).
• Visual Studio IDE (Edisi Komunitas Gratis Cukup; Pastikan untuk Menginstal Dukungan C ++).

Anda dapat menggunakan aplikasi Windows Chet 64-bit yang telah dikompilasi sebelumnya di direktori Bin .

Jika Anda ingin mengkompilasi Chet sendiri, maka Anda juga memerlukan liblat untuk Delphi dan memastikan Ide Delphi dapat menemukannya (proyek Chet akan menemukannya secara otomatis jika direktori Neslib.Clang berada pada tingkat yang sama dengan direktori Chet ).

Kontribusi

Terima kasih atas kontribusi ini:

• Michał Sznajder untuk peningkatan konversi char.
• Chiptamer untuk menambahkan dukungan untuk deklarasi yang diketik.
• Jarrod Davis karena menambahkan dukungan pasca pemrosesan.
• Alexey.t untuk menambahkan dukungan untuk bidang bit yang dikemas dalam C Structs, pemetaan tipe yang ditentukan pengguna, dan kemampuan untuk mengabaikan file header tertentu.

Panduan Pengguna

Chet cukup mudah. Dalam banyak kasus, Anda hanya perlu memberikan direktori dengan file header, nama file output .pas dan pilih "Jalankan header translator (F9)".

Untuk kontrol lebih lanjut atas proses konversi, Anda dapat menentukan berbagai opsi, yang dijelaskan di bawah ini.

Menu

Setiap opsi konfigurasi yang Anda atur dapat disimpan ke file konfigurasi .chet (yang merupakan file ini sederhana). Ini memungkinkan Anda untuk memuat pengaturan nanti untuk menjalankan kembali konversi (misalnya, ketika versi baru dari file header telah dirilis). Anda dapat memuat dan menyimpan opsi konfigurasi ini menggunakan menu File .

Untuk membantu pra-konfigurasi beberapa pengaturan untuk sesi baru, pilih File | New Project... (Ctrl+N) . Anda memasukkan nama proyek dan Chet akan mengkonfigurasi beberapa pengaturan berdasarkan nama yang Anda masukkan (meskipun Anda selalu dapat memodifikasi pengaturan tersebut nanti).

Menu Run tepat sebagai Run Header Translator opsi tunggal, yang juga dapat Anda aktifkan dengan F9 .

Halaman proyek

Halaman Proyek berisi opsi konfigurasi paling penting:

• Direktori dengan file header C : Tentukan direktori dengan file .h file di sini. Direktori mungkin relatif terhadap direktori yang berisi file proyek .chet . Klik tombol ... untuk menelusuri direktori. Dianjurkan agar Anda tidak menggunakan direktori dengan kode sumber C asli. Sebaliknya, salin file header ke direktori terpisah hanya untuk tujuan konversi. Ini membuatnya lebih mudah untuk menghapus file header yang tidak ingin Anda konversi, atau melakukan pengeditan ke file header untuk tujuan konversi.
• Sertakan subdirektori : centang kotak ini jika file header tersebar di beberapa direktori. Dalam hal ini, Chet akan mencari semua subdirektori dari direktori yang diberikan juga.
• File Pascal Target : Tentukan nama file .pas yang akan dihasilkan. File Pascal gabungan tunggal saya akan dihasilkan untuk semua file header yang diuraikan. Nama tersebut mungkin relatif terhadap direktori yang berisi file proyek .chet . Klik tombol ... untuk membuka dialog Simpan.
• Daftar unit yang dipisahkan secara koma untuk "menggunakan" : Jika file header bergantung pada deklarasi di beberapa unit Delphi lainnya (seperti Windows.Winapi ), maka Anda dapat mendaftar unit-unit itu di sini. Akan ditambahkan ke klausa penggunaan file Pascal yang dihasilkan.

Halaman platform

Pada halaman ini Anda menentukan platform apa yang ingin Anda targetkan, dan bagaimana Anda ingin mengonfigurasinya.

• Konstanta Perpustakaan : Tentukan nama konstanta yang akan digunakan untuk nama perpustakaan. Misalnya, jika Anda memiliki perpustakaan yang disebut "mylib.dll", maka nama konstanta ini bisa LIB_MYLIB , sehingga deklarasi berikut akan dihasilkan: const LIB_MYLIB = 'mylib.dll' .

Berikutnya adalah kotak centang untuk semua platform yang ingin Anda targetkan (windows 32-bit, windows 64-bit, macOS 32-bit, 64-bit Linux, iOS dan Android). Untuk setiap platform yang Anda periksa, Anda harus memasukkan opsi berikut:

• Nama Perpustakaan : Nama Perpustakaan Dinamis atau Statis untuk Platform **. **
• Awalan (_pu) : Awalan nama fungsi untuk digunakan untuk platform. Ini biasanya bisa dibiarkan kosong. Tetapi, tergantung pada bagaimana perpustakaan dibangun, semua nama fungsi dapat diawali (biasanya dengan karakter _ yang menggarisbawahi).

Halaman opsi parse

Di sini Anda dapat menyesuaikan proses parsing dentang.

• Abaikan kesalahan parse : centang kotak ini untuk mengabaikan kesalahan parsing dan mencoba menerjemahkan file header. Perhatikan bahwa ini dapat menyebabkan output yang salah, jadi Anda biasanya harus membiarkan opsi ini tidak dicentang. Anda mungkin menemukan opsi ini berguna sebagai opsi sementara untuk memeriksa kesalahan penguraian. Biasanya, dentang akan berhenti parsing setelah menemukan kesalahan fatal pertama. Dengan mencentang kotak ini, itu akan menunjukkan semua kesalahan penguraian (hingga batas), sehingga Anda dapat mengatasinya dan kemudian menghapus centang kotak ini lagi.
• Argumen baris perintah untuk diteruskan ke Clang : Tentukan argumen baris perintah apa pun untuk diteruskan ke kompiler dentang di sini. Biasanya tidak perlu untuk ini, tetapi beberapa proyek C mungkin memerlukan beberapa argumen baris perintah untuk parsing untuk berhasil. Argumen baris perintah paling umum yang mungkin Anda butuhkan adalah menambahkan preprocessor yang ditentukan ( -D<define> ) dan sertakan jalur pencarian ( -I<path> ). Ada tombol terpisah untuk membuatnya lebih mudah untuk menambahkan ini. Lihat dokumentasi dentang untuk informasi tentang argumen baris perintah yang tersedia.

Opsi konversi

Di sinilah Anda menyesuaikan output yang dihasilkan.

• Konvensi Panggilan : Tentukan konvensi panggilan yang akan digunakan untuk semua fungsi yang diterjemahkan. Anda dapat memilih antara cdecl dan stdcall . Dalam hampir semua kasus, Anda harus menggunakan konvensi panggilan cdecl default. Gunakan stdcall hanya untuk 32-bit Windows DLL yang Anda tahu dikompilasi dengan konvensi panggilan stdcall. Itu biasanya hanya sistem Windows DLL. Sebagian besar pihak ke -3 menggunakan cdecl.
• Penanganan Komentar : Di sini Anda menentukan cara menangani komentar dokumentasi (lihat juga komentar di bawah):
  • Simpan komentar apa adanya (default): Jangan mengonversi komentar, tetapi simpan dalam gaya aslinya (doxygen).
  • Hapus Komentar : Semua komentar akan dihapus.
  • Konversi komentar ke gaya XMLDOC (eksperimental) : Konversi komentar gaya Doxygen ke komentar gaya XMLDOC (gaya dokumentasi default untuk Delphi). Fitur ini masih sedang dibangun dan dianggap eksperimental.
  • Konversi komentar ke gaya pasdoc (eksperimental) : Konversi komentar bergaya doxygen ke komentar gaya pasdoc. Fitur ini masih sedang dibangun dan dianggap eksperimental.
• Konversi "char" ke : tipe C char adalah ambigu, dapat digunakan sebagai bilangan bulat 8-bit atau karakter dalam string teks. Versi yang diketik signed char dan unsigned char selalu dikonversi menjadi Shortint dan Byte masing -masing. Tetapi ketika tidak ada penandatanganan yang ditentukan, Anda memiliki opsi berikut:
  • UTF8CHAR (default): Konversi char ke UTF8Char lintas platform.
  • Shortint : Konversi char menjadi Shortint 8-bit yang ditandatangani.
  • BYTE : Konversi char ke Byte 8-bit unsigned.
• Penanganan Kata yang Dicadangkan : File header dapat menggunakan pengidentifikasi yang bertentangan dengan kata -kata yang dicadangkan di Delphi (seperti begin dan procedure ). Di sini Anda menentukan bagaimana Anda ingin mengonversi pengidentifikasi ini:
  • Tambahkan leading '&' (default): awalan pengidentifikasi dengan ampersand.
  • Tambahkan '_' : awalan pengidentifikasi dengan garis bawah.
  • Tambahkan trailing '_' : Tambahkan garis bawah ke ujung pengidentifikasi.
• Perlakukan arahan sebagai kata yang dipesan : apakah akan memperlakukan arahan Delphi sebagai kata -kata yang dipesan juga (diperiksa secara default). Secara teknis, Anda diizinkan untuk menggunakan banyak arahan (seperti public ) sebagai pengidentifikasi di Delphi, tetapi terlihat aneh dan sintrax highlighter Delphi memperlakukan mereka secara berbeda. Jadi Anda biasanya ingin memperlakukan ini sebagai kata -kata yang dipesan juga.
• ENUM HANDLING : Anda memiliki opsi untuk mengonversi C enum dalam dua cara:
  • Konversi ke tipe yang disebutkan (default): Konversi ke tipe yang disebutkan Delphi.
  • Konversi ke tipe dan konstanta integer : Konversi nama tipe itu sendiri menjadi bilangan bulat (seperti pada type MyEnum = Integer; ) dan buat konstanta untuk setiap opsi dalam enumerasi. Ini mungkin lebih berlaku untuk beberapa perpustakaan.
• Deklarasi yang tidak dapat dikonversi : Terlepas dari upaya terbaik, Chet mungkin tidak dapat mengonversi semua deklarasi (terutama #define , lihat komentar di bawah). Di sini Anda menentukan cara menangani ini:
  • Tulis item TODO (default): Menulis komentar TODO ke kode sumber Delphi, serta versi yang dikomentari dari deklarasi asli. Ingatlah bahwa Anda dapat melihat daftar semua todo di Delphi Ide dengan memilih View | Tool Windows | To-Do List .
  • Komentari Deklarasi Asli : Menulis versi yang dikomentari dari deklarasi asli ke kode sumber Delphi.
  • Abaikan Deklarasi : Mengabaikan Deklarasi dan tidak menulis apa pun kepada Kode Sumber Delphi.

Perhatikan bahwa hanya komentar dokumentasi gaya doxygen yang diuraikan oleh dentang. Ini adalah komentar yang mengikuti konvensi format ini:

• /// 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 mencoba mengkonversi deklarasi #define menjadi konstanta jika memungkinkan. Ini hanya berfungsi jika:

• Define tidak seperti fungsi. Artinya, makro seperti #define ABS(x) (x < 0) ? -x : x tidak dapat diterjemahkan.
• Define menggunakan ekspresi yang hanya menggunakan definisi dan literal lain. Misalnya: #define FOO 3<<BAR akan dikonversi menjadi const FOO = 3 shl BAR .

Abaikan halaman

Di sini Anda dapat menentukan daftar simbol yang harus diabaikan. Simbol -simbol ini tidak akan diterjemahkan.

Penggunaan yang paling umum adalah mengabaikan #define yang menghasilkan kesalahan konversi, atau fungsi yang tidak Anda butuhkan. Anda juga dapat memilih untuk mengabaikan beberapa jenis, tetapi itu dapat mengakibatkan kesalahan kompilasi nanti karena jenis yang diharapkan hilang.

Perhatikan bahwa simbol sensitif terhadap case.

Halaman Terjemahan

Halaman terakhir hanya memiliki satu tombol "Run Header Translator" (yang juga dapat Anda aktifkan dengan F9 ). Ini menunjukkan kemajuan proses terjemahan, serta kesalahan yang terjadi saat menguraikan file header.

Anda dapat menggunakan kesalahan ini untuk memperbaiki file header, menambahkan file header yang hilang, atau mengkonfigurasi proses parsing itu dengan menambahkan argumen baris perintah (misalnya, dengan menambahkan jalur pencarian termasuk).

Lisensi

Chet dilisensikan di bawah lisensi BSD yang disederhanakan. Lihat lisensi.txt untuk detailnya.