Aturan Tindakan Tambahan

Aturan

action_listener

action_listener(name, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, extra_actions, features, licenses, mnemonics, restricted_to, tags, target_compatible_with, testonly, visibility)

PERINGATAN: Tindakan tambahan tidak digunakan lagi. Gunakan aspects sebagai gantinya.

Aturan action_listener tidak menghasilkan output apa pun. Sebagai gantinya, developer alat dapat menyisipkan extra_action ke dalam sistem build, dengan menyediakan pemetaan dari tindakan ke extra_action .

Argumen aturan ini memetakan mnemonik tindakan ke aturan extra_action.

Dengan menentukan opsi --experimental_action_listener=<label>, build akan menggunakan action_listener yang ditentukan untuk menyisipkan extra_action ke grafik build.

Contoh

action_listener(
    name = "index_all_languages",
    mnemonics = [
        "Javac",
        "CppCompile",
        "Python",
    ],
    extra_actions = [":indexer"],
)

action_listener(
    name = "index_java",
    mnemonics = ["Javac"],
    extra_actions = [":indexer"],
)

extra_action(
    name = "indexer",
    tools = ["//my/tools:indexer"],
    cmd = "$(location //my/tools:indexer)" +
          "--extra_action_file=$(EXTRA_ACTION_FILE)",
)

Argumen

Atribut
name

Name; required

Nama unik untuk target ini.

extra_actions

List of labels; required

Daftar target extra_action yang harus ditambahkan action_listener ini ke grafik build. Misalnya [ "//my/tools:analyzer" ].
mnemonics

List of strings; required

Daftar mnemonik tindakan yang harus dideteksi action_listener ini, misalnya [ "Javac" ].

Mnemonik bukan antarmuka publik. Tidak ada jaminan bahwa mnemonik dan tindakannya tidak berubah.

ekstra_tindakan

extra_action(name, data, cmd, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, out_templates, requires_action_output, restricted_to, tags, target_compatible_with, testonly, toolchains, tools, visibility)

PERINGATAN: Tindakan tambahan tidak digunakan lagi. Gunakan aspects sebagai gantinya.

Aturan extra_action tidak menghasilkan output apa pun yang bermakna jika ditetapkan sebagai target build reguler. Sebaliknya, developer alat dapat menyisipkan tindakan tambahan ke dalam grafik build yang membayangi tindakan yang sudah ada.

Lihat action_listener untuk mengetahui detail tentang cara mengaktifkan extra_action.

extra_action dijalankan sebagai command line. Alat command line mendapatkan akses ke file yang berisi buffering protokol sebagai $(EXTRA_ACTION_FILE) dengan informasi mendetail tentang tindakan aslinya yang dibayangi. Aplikasi juga memiliki akses ke semua file input yang dapat diakses oleh tindakan asli. Lihat extra_actions_base.proto untuk detail tentang data yang disimpan di dalam buffering protokol. Setiap file proto berisi pesan ExtraActionInfo.

Sama seperti semua tindakan lainnya, tindakan ekstra adalah sandbox, dan harus dirancang untuk menanganinya.

Argumen

Atribut
name

Name; required

Nama unik untuk target ini.

Anda dapat merujuk ke aturan ini paling lambat label dalam argumen extra_actions aturan action_listener.
cmd

String; required

Perintah yang akan dijalankan.

Seperti atribut cmd genrule dengan perbedaan berikut:

  1. Tidak ada perluasan label heuristik. Hanya label yang menggunakan $(location ...) yang diperluas.

  2. Penerusan tambahan diterapkan ke string untuk menggantikan semua kemunculan output yang dibuat dari atribut out_templates. Semua kemunculan $(output out_template) diganti dengan jalur ke file yang dilambangkan dengan label.

    Misalnya, out_template $(ACTION_ID).analysis dapat dicocokkan dengan $(output $(ACTION_ID).analysis).

    Akibatnya, ini adalah substitusi yang sama dengan $(location), tetapi dengan cakupan yang berbeda.

out_templates

List of strings; optional

Daftar template untuk file yang dihasilkan oleh perintah extra_action.

Template ini dapat menggunakan variabel-variabel berikut:

  • $(ACTION_ID), ID yang secara unik mengidentifikasi extra_action ini. Digunakan untuk menghasilkan file output unik.

requires_action_output

Boolean; optional; default is False

Menunjukkan extra_action ini memerlukan output tindakan asli untuk ada sebagai input ke extra_action ini.

Jika benar (default salah), extra_action dapat mengasumsikan bahwa output tindakan asli tersedia sebagai bagian dari inputnya.

tools

List of labels; optional

Daftar dependensi tool untuk aturan ini.

Lihat definisi dependensi untuk mengetahui informasi selengkapnya.

Sistem build memastikan prasyarat ini dibuat sebelum menjalankan perintah extra_action; build dibuat menggunakan hostkonfigurasi, karena harus dijalankan sebagai alat selama proses build sendiri. Jalur //x:y target tools individual dapat diperoleh menggunakan $(location //x:y).

Semua alat dan dependensi datanya digabungkan menjadi satu hierarki tempat perintah dapat menggunakan jalur relatif. Direktori kerja akan menjadi root dari hierarki terpadu tersebut.