Update katalog otomatis dan integrasi LSP

Platform Software Defined Vehicle (SDV) berisi banyak katalog VSIDL di seluruh codebase. File CATALOG_UPDATE menyediakan konfigurasi terpusat untuk setiap katalog, sehingga memungkinkan update otomatis dan integrasi IDE.

Peran file CATALOG_UPDATE

File CATALOG_UPDATE memiliki dua tujuan utama:

  1. Update otomatis: File ini memungkinkan alat regenerator menemukan dan mengompilasi ulang semua katalog dalam sistem saat compiler atau dependensi berubah.
  2. Dukungan Language Server Protocol (LSP): Server Bahasa VSIDL menggunakan file ini untuk menemukan root katalog dan menyelesaikan dependensi. Tindakan ini mengaktifkan fitur seperti "Buka Definisi", pelengkapan otomatis, dan validasi real-time untuk jenis yang ditentukan dalam katalog lain.

Mengonfigurasi katalog

Untuk mengaktifkan update otomatis dan dukungan LSP untuk katalog VSIDL, buat file CATALOG_UPDATE di direktori utama katalog. File ini adalah file protobuf teks.

Kolom konfigurasi katalog

  • output_path (string, opsional): Jalur relatif dari root katalog ke direktori tempat kode middleware yang dihasilkan harus ditempatkan.
  • dependency_catalog_paths (string berulang): Daftar jalur relatif ke direktori katalog lainnya. Server LSP menggunakan jalur ini untuk me-resolve jenis eksternal.
  • vsidlc_gen_args (string, opsional): Argumen yang diteruskan ke vsidlc. Server LSP memeriksa hal ini untuk menerapkan aturan validasi yang benar (misalnya, "--apex").
  • prebuilts_output_path (string, opsional): Jalur untuk prebuilt konfigurasi runtime yang dihasilkan.
  • prebuilts_filegroup (string, opsional): Nama filegroup Soong untuk prebuilt.

Contoh konfigurasi

# proto-file: //system/software_defined_vehicle/tools/regenerator/proto/catalog.proto
# proto-message: Catalog

output_path: ".."
dependency_catalog_paths: "../../../../../automotive_services/diagnostics/vsidl/v1"
vsidlc_gen_args: "--apex"

Alasan update otomatis diperlukan

Mempertahankan kode yang dihasilkan secara manual untuk setiap katalog akan menimbulkan masalah karena beberapa alasan:

  1. Update compiler: Saat compiler diupdate dengan perbaikan bug atau fitur baru, semua kode dan file yang dihasilkan yang tidak tercakup oleh genrule dalam file Android.bp harus diperbarui untuk menjaga konsistensi.
  2. Pengelolaan dependensi: Perubahan dalam katalog dasar sering kali mengharuskan katalog downstream dibuat ulang.
  3. Akurasi: Update otomatis mengurangi risiko kesalahan manusia saat menentukan jalur dan dependensi.

Menjalankan alat regenerator

Alat regenerator akan menelusuri hierarki direktori mulai dari root SDV dan mencari file yang bernama persis CATALOG_UPDATE.

Untuk memperbarui semua katalog yang dikonfigurasi:

  1. Bangun alat:

    m regenerator
    
  2. Jalankan alat:

    regenerator
    

    Atau, jalankan secara rekursif untuk direktori tertentu: console regenerator --root /path/to/directory

Alat ini mengupdate file yang dihasilkan dan melakukan build penuh (m droid) untuk memverifikasi bahwa perubahan tersebut kompatibel dengan bagian sistem lainnya.