Chet

Chet - C Header Translator สำหรับ Delphi

Chet เป็นนักแปล .h-to-.pas ขับเคลื่อนโดย libclang สำหรับ Delphi

คุณสมบัติ

ซึ่งแตกต่างจากนักแปลส่วนหัวอื่น ๆ Chet ใช้คอมไพเลอร์ Clang เพื่อแยกวิเคราะห์ไฟล์ส่วนหัวทำให้เกิดการแปลที่แม่นยำยิ่งขึ้นซึ่งต้องมีการปรับเปลี่ยนด้วยตนเองน้อยลง

คุณสมบัติที่โดดเด่นบางอย่างคือ:

• แปลประเภทข้อมูล C เช่น structs, Union, enums, typedefs, ประเภทขั้นตอนและประเภททึบแสง
• แปลฟังก์ชั่น C เป็นขั้นตอนหรือฟังก์ชั่น Delphi
• พยายามแปล #define ประกาศเป็นค่าคงที่หากเป็นไปได้
• สร้างไฟล์ .pas เดียวสำหรับไดเรกทอรีทั้งหมดของไฟล์. .h สิ่งนี้จะช่วยลดปัญหาเนื่องจากการพึ่งพาระหว่างไฟล์ส่วนหัว
• สร้างผลลัพธ์สำหรับหลายแพลตฟอร์ม (winsows, macOS, linux, iOS และ Android) หากต้องการ
• คุณสามารถปรับแต่งกระบวนการแยกวิเคราะห์เสียงดังโดยการจัดหาอาร์กิวเมนต์บรรทัดคำสั่งให้กับคอมไพเลอร์
• คุณสามารถปรับแต่งผลลัพธ์ของการดำเนินการแปลงบางอย่าง
• รักษาความคิดเห็นเอกสารสไตล์ Doxygen หากต้องการหรือแปลงเป็นความคิดเห็น XMLDOC หรือความคิดเห็น pasdoc
• จัดเตรียม GUI สำหรับการกำหนดค่ากระบวนการแปลงและช่วยให้คุณสามารถบันทึกการตั้งค่าการแปลงเป็นไฟล์โครงการ .chet เพื่อนำกลับมาใช้ใหม่

ข้อ จำกัด

• Chet ทำงานเฉพาะกับไฟล์ส่วนหัว C ไม่ใช่ ด้วยไฟล์ส่วนหัว C ++
• ฟังก์ชั่นที่ไม่ จำกัด ทั้งหมดในไฟล์ส่วนหัวได้รับการแปลและสันนิษฐานว่ามีอยู่ในไลบรารีแบบคงที่หรือแบบไดนามิกสำหรับโครงการ สิ่งนี้ไม่จำเป็นต้องเป็นเช่นนั้น (ฟังก์ชั่นที่ไม่เคยถูกแปลเนื่องจากไม่เคยมีอยู่ในห้องสมุด)
• เนื่องจาก Clang ถูกใช้เพื่อแยกวิเคราะห์ไฟล์ส่วนหัวซึ่งหมายความว่าการประมวลผล preprocessor นั้นทำงานได้ดีเพื่อทำการแยกวิเคราะห์แบบ #ifdef เงื่อนไข นี่คือทั้งดีและไม่ดี มันดีเพราะช่วยปรับปรุงความแม่นยำในการแปลง แต่มันอาจจะไม่ดีเพราะใช้ระบบที่ Chet ทำงานเพื่อกำหนดเส้นทางที่มีเงื่อนไขบางอย่าง ตัวอย่างเช่นเนื่องจาก CHET ทำงานบน Windows มันจะแยกวิเคราะห์รหัสใน #ifdef _WIN32 ส่วน แต่ข้ามรหัสใด ๆ ในส่วนสำหรับแพลตฟอร์มอื่น ๆ

ความต้องการ

เนื่องจาก Chet ใช้คอมไพเลอร์จริงคุณจะต้องมีการพัฒนาสภาพแวดล้อม (น้อยที่สุด) C ที่ติดตั้งรวมถึง LLVM กับเสียงดัง เสียงดังจะต้องสามารถค้นหาส่วนหัวของระบบสำหรับสภาพแวดล้อมการพัฒนา โดยปกติแล้วสิ่งเหล่านี้จะพร้อมใช้งานหากคุณมี Visual Studio บางรุ่นที่ติดตั้ง Visual C ++ Visual Studio ฉบับฟรี (ชุมชน) พอเพียง

คุณสามารถเรียกใช้ Chet ก่อนเพื่อตรวจสอบข้อผิดพลาดใด ๆ ที่เกี่ยวข้องกับการพึ่งพาที่ขาดหายไป หากคุณได้รับข้อผิดพลาดในการพึ่งพาเมื่อเรียกใช้นักแปลคุณสามารถดาวน์โหลดการอ้างอิงได้ที่นี่:

• LLVM พร้อม Clang (Clang for Windows (64 บิต) แนะนำ)
• Visual Studio IDE (Free Community Edition เพียงพอแล้วอย่าลืมติดตั้งการสนับสนุน C ++)

คุณสามารถใช้แอปพลิเคชัน Windows Chet 64 บิตที่คอมไพล์ไว้ล่วงหน้าในไดเรกทอรี Bin

หากคุณต้องการรวบรวม Chet ด้วยตัวเองคุณต้องใช้ libclang สำหรับ Delphi และตรวจสอบให้แน่ใจว่า Delphi IDE สามารถค้นหาได้ (โครงการ Chet จะพบโดยอัตโนมัติหากไดเรกทอรี Neslib.Clang อยู่ในระดับเดียวกับไดเรกทอรี Chet )

ผลงาน

ขอบคุณสำหรับผลงานเหล่านี้:

• Michał Sznajder สำหรับการแปลงถ่านที่ดีขึ้น
• Chiptamer สำหรับการเพิ่มการสนับสนุนสำหรับการประกาศ const ที่พิมพ์
• Jarrod Davis สำหรับการเพิ่มการสนับสนุนหลังการประมวลผล
• Alexey.t สำหรับการเพิ่มการสนับสนุนสำหรับฟิลด์บิตที่บรรจุในโครงสร้าง C การแมปประเภทที่ผู้ใช้กำหนดและความสามารถในการละเว้นไฟล์ส่วนหัวบางไฟล์

คู่มือผู้ใช้

เชตค่อนข้างตรงไปตรงมา ในหลายกรณีคุณจะต้องจัดเตรียมไดเรกทอรีที่มีไฟล์ส่วนหัวชื่อของไฟล์ .pas และเลือก "เรียกใช้ส่วนหัวนักแปล (F9)"

สำหรับการควบคุมกระบวนการแปลงเพิ่มเติมคุณสามารถระบุตัวเลือกต่าง ๆ ที่อธิบายไว้ด้านล่าง

เมนู

ตัวเลือกการกำหนดค่าใด ๆ ที่คุณตั้งค่าสามารถบันทึกไว้ในไฟล์การกำหนดค่า .chet (ซึ่งเป็นไฟล์ ini-file ที่เรียบง่าย) สิ่งนี้ช่วยให้คุณสามารถโหลดการตั้งค่าในภายหลังเพื่อเรียกใช้การแปลงใหม่ (ตัวอย่างเช่นเมื่อไฟล์ส่วนหัวเวอร์ชันใหม่ได้รับการเผยแพร่) คุณสามารถโหลดและบันทึกตัวเลือกการกำหนดค่าเหล่านี้โดยใช้เมนู File

หากต้องการช่วยกำหนดค่าล่วงหน้าการตั้งค่าบางอย่างสำหรับเซสชันใหม่ให้เลือก File | New Project... (Ctrl+N) คุณป้อนชื่อของโครงการและ Chet จะกำหนดค่าการตั้งค่าบางอย่างตามชื่อที่คุณป้อน (แม้ว่าคุณจะสามารถแก้ไขการตั้งค่าเหล่านั้นได้ในภายหลัง)

เมนู Run เช่นเดียวกับ Run Header Translator ซึ่งคุณสามารถเปิดใช้งานด้วย F9

หน้าโครงการ

หน้าโครงการมีตัวเลือกการกำหนดค่าที่สำคัญที่สุด:

• ไดเรกทอรีที่มีไฟล์ส่วนหัว C : ระบุไดเรกทอรีด้วยไฟล์ .h ที่มาที่นี่ ไดเรกทอรีอาจสัมพันธ์กับไดเรกทอรีที่มีไฟล์. .chet Project คลิกปุ่ม ... เพื่อเรียกดูไดเรกทอรี ขอแนะนำให้คุณไม่ใช้ไดเรกทอรีกับซอร์สโค้ด C ดั้งเดิม ให้คัดลอกไฟล์ส่วนหัวไปยังไดเรกทอรีแยกต่างหากเพื่อวัตถุประสงค์ในการแปลง สิ่งนี้ทำให้ง่ายต่อการลบไฟล์ส่วนหัวที่คุณไม่ต้องการแปลงหรือทำการแก้ไขเป็นไฟล์ส่วนหัวเพื่อวัตถุประสงค์ในการแปลง
• รวมไดเรกทอรีย่อย : ทำเครื่องหมายในช่องนี้หากไฟล์ส่วนหัวกระจายไปทั่วหลายไดเรกทอรี ในกรณีนี้ Chet จะค้นหาไดเรกทอรีย่อยทั้งหมดของไดเรกทอรีที่กำหนดเช่นกัน
• ไฟล์ Pascal Target : ระบุชื่อของไฟล์ .pas ที่จะสร้างขึ้น ฉันไฟล์ Pascal แบบรวมเดียวจะถูกสร้างขึ้นสำหรับไฟล์ส่วนหัวที่แยกวิเคราะห์ทั้งหมด ชื่ออาจสัมพันธ์กับไดเรกทอรีที่มีไฟล์ .chet Project คลิกปุ่ม ... เพื่อเปิดกล่องโต้ตอบบันทึก
• รายการหน่วยที่คั่นด้วยเครื่องหมายจุลภาคเพื่อ "ใช้" : หากไฟล์ส่วนหัวขึ้นอยู่กับการประกาศในหน่วย Delphi อื่น ๆ (เช่น Windows.Winapi ) คุณสามารถแสดงรายการหน่วยเหล่านั้นได้ที่นี่ จะถูกเพิ่มเข้าไปในประโยคการใช้งานของไฟล์ Pascal ที่สร้างขึ้น

หน้าแพลตฟอร์ม

ในหน้านี้คุณระบุแพลตฟอร์มที่คุณต้องการกำหนดเป้าหมายและวิธีที่คุณต้องการกำหนดค่า

• ค่าคงที่ของไลบรารี : ระบุชื่อของค่าคงที่ที่จะใช้สำหรับชื่อไลบรารี ตัวอย่างเช่นหากคุณมีไลบรารีที่เรียกว่า "mylib.dll" ชื่อของค่าคงที่นี้อาจเป็น LIB_MYLIB ดังนั้นการประกาศต่อไปนี้จะถูกสร้างขึ้น: const LIB_MYLIB = 'mylib.dll'

ถัดไปคือช่องทำเครื่องหมายสำหรับทุกแพลตฟอร์มที่คุณต้องการกำหนดเป้าหมาย (หน้าต่าง 32 บิต, Windows 64 บิต, MacOS 32 บิต, Linux 64 บิต, iOS และ Android) สำหรับแต่ละแพลตฟอร์มที่คุณตรวจสอบคุณต้องป้อนตัวเลือกต่อไปนี้:

• ชื่อไลบรารี : ชื่อของไลบรารีแบบไดนามิกหรือแบบคงที่สำหรับแพลตฟอร์ม **. **
• คำนำหน้า (_pu) : คำนำหน้าชื่อฟังก์ชันที่จะใช้สำหรับแพลตฟอร์ม โดยปกติแล้วจะว่างเปล่า แต่ขึ้นอยู่กับวิธีการสร้างห้องสมุดชื่อฟังก์ชั่นทั้งหมดอาจถูกนำหน้า (โดยปกติจะมีอักขระขีดล่าง _ )

หน้าตัวเลือกการแยกวิเคราะห์

ที่นี่คุณสามารถปรับแต่งกระบวนการแยกวิเคราะห์เสียงดัง

• ละเว้นข้อผิดพลาดของการแยกวิเคราะห์ : ทำเครื่องหมายในช่องนี้เพื่อละเว้นข้อผิดพลาดการแยกวิเคราะห์ใด ๆ และพยายามแปลไฟล์ส่วนหัวต่อไป โปรดทราบว่าสิ่งนี้อาจนำไปสู่ผลลัพธ์ที่ไม่ถูกต้องดังนั้นโดยทั่วไปคุณควรปล่อยให้ตัวเลือกนี้ไม่ถูกตรวจสอบ คุณอาจพบว่าตัวเลือกนี้มีประโยชน์เป็นตัวเลือกชั่วคราวในการตรวจสอบข้อผิดพลาดในการแยกวิเคราะห์ โดยปกติแล้วเสียงดังจะหยุดการแยกวิเคราะห์หลังจากพบข้อผิดพลาดร้ายแรงครั้งแรก โดยการทำเครื่องหมายในช่องนี้จะแสดงข้อผิดพลาดในการแยกวิเคราะห์ทั้งหมด (สูงสุดถึงขีด จำกัด ) ดังนั้นคุณสามารถจัดการกับสิ่งเหล่านั้นแล้วยกเลิกการตรวจสอบกล่องนี้อีกครั้ง
• อาร์กิวเมนต์บรรทัดคำสั่งที่จะส่งผ่านไปยัง Clang : ระบุอาร์กิวเมนต์บรรทัดคำสั่งใด ๆ ที่จะส่งผ่านไปยังคอมไพเลอร์ Clang ที่นี่ โดยปกติจะไม่จำเป็นสำหรับสิ่งนี้ แต่โครงการ C บางโครงการอาจต้องใช้ข้อโต้แย้งบรรทัดคำสั่งบางอย่างเพื่อให้การแยกวิเคราะห์ประสบความสำเร็จ อาร์กิวเมนต์บรรทัดคำสั่งที่พบบ่อยที่สุดที่คุณอาจต้องการคือการเพิ่มตัวประมวลผลล่วงหน้ากำหนด ( -D<define> ) และรวมเส้นทางการค้นหา ( -I<path> ) มีปุ่มแยกต่างหากเพื่อให้ง่ายต่อการเพิ่มสิ่งเหล่านี้ อ้างถึงเอกสาร Clang สำหรับข้อมูลเกี่ยวกับอาร์กิวเมนต์บรรทัดคำสั่งที่มีอยู่

ตัวเลือกการแปลง

นี่คือที่ที่คุณปรับแต่งผลลัพธ์ที่สร้างขึ้น

• Convention Calling : ระบุอนุสัญญาการโทรเพื่อใช้สำหรับฟังก์ชั่นที่แปลทั้งหมด คุณสามารถเลือกระหว่าง cdecl และ stdcall ในเกือบทุกกรณีคุณควรใช้การประชุมการเรียก cdecl เริ่มต้น ใช้ stdcall สำหรับ Windows DLL 32 บิตเท่านั้นซึ่งคุณรู้ว่ารวบรวมด้วยการประชุมการเรียก STDCALL โดยปกติแล้วจะเป็นเพียงระบบ Windows DLL เท่านั้น DLL ของบุคคลที่สามส่วนใหญ่ใช้ CDECL
• การจัดการความคิดเห็น : ที่นี่คุณระบุวิธีจัดการความคิดเห็นของเอกสาร (ดูข้อสังเกตด้านล่าง):
  • แสดงความคิดเห็นตามที่เป็น (ค่าเริ่มต้น): อย่าแปลงความคิดเห็น แต่เก็บไว้ในสไตล์ดั้งเดิม (doxygen)
  • ลบความคิดเห็น : ความคิดเห็นทั้งหมดจะถูกลบออก
  • แปลงความคิดเห็นเป็นสไตล์ xmldoc (ทดลอง) : แปลงความคิดเห็นสไตล์ doxygen เป็นความคิดเห็นสไตล์ xmldoc (รูปแบบเอกสารเริ่มต้นสำหรับ Delphi) คุณลักษณะนี้ยังอยู่ระหว่างการก่อสร้างและพิจารณาการทดลอง
  • แปลงความคิดเห็นเป็นสไตล์ Pasdoc (ทดลอง) : แปลงความคิดเห็นสไตล์ Doxygen เป็นความคิดเห็นสไตล์ Pasdoc คุณลักษณะนี้ยังอยู่ระหว่างการก่อสร้างและพิจารณาการทดลอง
• แปลง "ถ่าน" เป็น : ประเภท C char นั้นไม่ชัดเจนมันสามารถใช้เป็นจำนวนเต็ม 8 บิตหรืออักขระในสตริงข้อความ เวอร์ชันพิมพ์ signed char และ unsigned char จะถูกแปลงเป็น Shortint และ Byte ตามลำดับเสมอ แต่เมื่อไม่มีการระบุการลงนามคุณมีตัวเลือกต่อไปนี้:
  • UTF8CHAR (ค่าเริ่มต้น): แปลง char เป็น Cross-Platform UTF8Char
  • SHORTINT : แปลง char เป็น 8 บิต Shortint นาม
  • ไบต์ : แปลง char เป็น Byte ที่ไม่ได้ลงชื่อ 8 บิต
• การจัดการคำที่สงวนไว้ : ไฟล์ส่วนหัวอาจใช้ตัวระบุที่ขัดแย้งกับคำที่สงวนไว้ใน Delphi (เช่น begin และ procedure ) ที่นี่คุณระบุวิธีที่คุณต้องการแปลงตัวระบุเหล่านี้:
  • เพิ่มชั้นนำ '&' (ค่าเริ่มต้น): คำนำหน้าตัวระบุด้วยแอมป์แซนด์
  • เพิ่มชั้นนำ '_' : คำนำหน้าตัวระบุด้วยขีดล่าง
  • เพิ่ม trailing '_' : เพิ่มขีดล่างลงในตอนท้ายของตัวระบุ
• ปฏิบัติตามคำสั่งเป็นคำที่สงวนไว้ : ไม่ว่าจะปฏิบัติตามคำสั่ง Delphi เป็นคำที่สงวนไว้เช่นกัน (ตรวจสอบโดยค่าเริ่มต้น) ในทางเทคนิคแล้วคุณได้รับอนุญาตให้ใช้คำสั่งมากมาย (เช่น public ) เป็นตัวระบุใน Delphi แต่มันดูแปลกและปากกาเน้นข้อความไวยากรณ์ของ Delphi ปฏิบัติต่อพวกเขาแตกต่างกัน ดังนั้นคุณมักจะต้องการปฏิบัติต่อสิ่งเหล่านี้เป็นคำที่สงวนไว้เช่นกัน
• การจัดการ enum : คุณมีตัวเลือกในการแปลง c enums ในสองวิธี:
  • แปลงเป็นประเภทที่แจกแจง (ค่าเริ่มต้น): แปลงเป็นประเภทที่แจกแจง Delphi
  • แปลงเป็นประเภทจำนวนเต็มและค่าคงที่ : แปลงชื่อประเภทตัวเองเป็นจำนวนเต็ม (เช่นใน type MyEnum = Integer; ) และสร้างค่าคงที่สำหรับแต่ละตัวเลือกในการแจงนับ สิ่งนี้อาจมีผลบังคับใช้มากขึ้นสำหรับห้องสมุดบางแห่ง
• การประกาศที่ไม่สามารถแก้ไขได้ : แม้จะมีความพยายามที่ดีที่สุด แต่ Chet อาจไม่สามารถแปลงการประกาศทั้งหมดได้ (โดยเฉพาะ #define 'ดูข้อสังเกตด้านล่าง) ที่นี่คุณระบุวิธีจัดการสิ่งเหล่านี้:
  • เขียนรายการ todo (ค่าเริ่มต้น): เขียนความคิดเห็น TODO ไปยังซอร์สโค้ด Delphi รวมถึงเวอร์ชันแสดงความคิดเห็นของการประกาศดั้งเดิม โปรดจำไว้ว่าคุณสามารถดูรายการสิ่งที่ต้องทำทั้งหมดใน Delphi IDE ได้โดยเลือก View | Tool Windows | To-Do List
  • แสดงความคิดเห็นการประกาศดั้งเดิม : เขียนเวอร์ชันที่แสดงความคิดเห็นของการประกาศดั้งเดิมไปยังซอร์สโค้ด Delphi
  • ละเว้นการประกาศ : ละเว้นการประกาศและไม่ได้เขียนอะไรลงในซอร์สโค้ด Delphi

โปรดทราบว่ามีเพียงความคิดเห็นของเอกสารสไตล์ Doxygen เท่านั้นที่แยกวิเคราะห์โดย 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) */

Chet พยายามแปลงการประกาศ #define เป็นค่าคงที่ถ้าเป็นไปได้ จะใช้ได้เฉพาะถ้า:

• การกำหนดไม่ใช่ฟังก์ชั่น นั่นคือแมโครเช่น #define ABS(x) (x < 0) ? -x : x ไม่สามารถแปลได้
• การกำหนดใช้การแสดงออกที่ใช้เฉพาะการกำหนดและตัวอักษรอื่น ๆ เท่านั้น ตัวอย่างเช่น: #define FOO 3<<BAR จะถูกแปลงเป็น const FOO = 3 shl BAR

เพิกเฉยต่อหน้า

ที่นี่คุณสามารถระบุรายการสัญลักษณ์ที่จะละเว้น สัญลักษณ์เหล่านี้จะไม่ถูกแปล

การใช้งานที่พบบ่อยที่สุดคือการเพิกเฉยต่อ #define ที่สร้างข้อผิดพลาดในการแปลงหรือฟังก์ชั่นที่คุณไม่ต้องการ นอกจากนี้คุณยังสามารถเลือกที่จะเพิกเฉยต่อบางประเภท แต่นั่นอาจส่งผลให้เกิดข้อผิดพลาดในการรวบรวมในภายหลังเนื่องจากประเภทที่คาดหวังหายไป

โปรดทราบว่าสัญลักษณ์มีความไวต่อตัวพิมพ์ใหญ่

แปลหน้า

หน้าสุดท้ายมีเพียงปุ่มเดียว "Run Header Translator" (ซึ่งคุณสามารถเปิดใช้งานด้วย F9 ) มันแสดงความคืบหน้าของกระบวนการแปลรวมถึงข้อผิดพลาดใด ๆ ที่เกิดขึ้นในขณะที่แยกวิเคราะห์ไฟล์ส่วนหัว

คุณสามารถใช้ข้อผิดพลาดเหล่านี้เพื่อแก้ไขไฟล์ส่วนหัวเพิ่มไฟล์ส่วนหัวที่หายไปหรือกำหนดค่ากระบวนการแยกวิเคราะห์โดยการเพิ่มอาร์กิวเมนต์บรรทัดคำสั่ง (ตัวอย่างเช่นโดยการเพิ่มรวมพา ธ การค้นหา)

ใบอนุญาต

Chet ได้รับใบอนุญาตภายใต้ใบอนุญาต BSD ที่เรียบง่าย ดู License.txt สำหรับรายละเอียด