กฎการดำเนินการเพิ่มเติม

7.3 · 7.2 · 7.1 · 7.0 · 6.5

กฎ

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)

คำเตือน: มีการเลิกใช้งานการดำเนินการเพิ่มเติม ให้ใช้ aspects แทน

กฎ action_listener จะไม่สร้างเอาต์พุตใดๆ เอง แต่จะช่วยให้นักพัฒนาเครื่องมือแทรก extra_action ลงในระบบบิลด์ได้ด้วยการแมปจากการดำเนินการไปยัง extra_action

อาร์กิวเมนต์ของกฎนี้จะแมปการดำเนินการบันทึกการดำเนินการกับกฎ extra_action

เมื่อระบุตัวเลือก --experimental_action_listener=<label> บิลด์จะใช้ action_listener ที่ระบุเพื่อแทรก extra_action ลงในกราฟบิลด์

ตัวอย่าง

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)",
)

อาร์กิวเมนต์

Attributes
name

ชื่อ ต้องระบุ

ชื่อที่ไม่ซ้ำกันสําหรับเป้าหมายนี้

extra_actions

รายการป้ายกำกับ (ต้องระบุ)

รายการเป้าหมาย extra_action ควรเพิ่มaction_listenerนี้ลงในกราฟการสร้าง เช่น [ "//my/tools:analyzer" ]
mnemonics

รายการสตริง ต้องระบุ

รายการคําช่วยจําสําหรับการดําเนินการที่ action_listener ควรฟัง เช่น [ "Javac" ]

Mnemonics ไม่ใช่อินเทอร์เฟซสาธารณะ และเรารับประกันไม่ได้ว่าความทรงจำและการกระทำเหล่านั้นจะไม่เปลี่ยนแปลง

extra_action

ดูแหล่งที่มาของกฎ
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)

คำเตือน: ระบบเลิกใช้งานการดำเนินการเพิ่มเติมแล้ว โปรดใช้ aspects แทน

กฎ extra_action จะไม่สร้างเอาต์พุตที่มีความหมายเมื่อระบุเป็นเป้าหมายการสร้างปกติ แต่จะช่วยให้นักพัฒนาเครื่องมือแทรกการดำเนินการเพิ่มเติมลงในกราฟบิลด์ที่ซ่อนการดำเนินการที่มีอยู่ได้

ดูรายละเอียดเกี่ยวกับวิธีเปิดใช้ extra_action ใน action_listener

extra_action จะทำงานเป็นบรรทัดคำสั่ง เครื่องมือบรรทัดคำสั่งจะเข้าถึงไฟล์ที่มีบัฟเฟอร์โปรโตคอลเป็น $(EXTRA_ACTION_FILE) โดยมีรายละเอียดการดำเนินการเดิมที่ระบบกำลังเงาอยู่ นอกจากนี้ยังมีสิทธิ์เข้าถึงไฟล์อินพุตทั้งหมดที่การดำเนินการเดิมมีสิทธิ์เข้าถึงด้วย ดูรายละเอียดเกี่ยวกับข้อมูลที่จัดเก็บไว้ในบัฟเฟอร์โปรโตคอลได้ที่ extra_actions_base.proto ไฟล์โปรโตแต่ละไฟล์จะมีข้อความ ExtraActionInfo

การดำเนินการเพิ่มเติมจะอยู่ในแซนด์บ็อกซ์เช่นเดียวกับการดำเนินการอื่นๆ ทั้งหมด และควรออกแบบมาให้จัดการการดำเนินการดังกล่าว

อาร์กิวเมนต์

Attributes
name

ชื่อ ต้องระบุ

ชื่อที่ไม่ซ้ำกันสําหรับเป้าหมายนี้

คุณอ้างอิงกฎนี้ได้โดยใช้ label ในอาร์กิวเมนต์ extra_actions ของกฎ action_listener
cmd

สตริง ต้องระบุ

คำสั่งที่จะเรียกใช้

เช่น แอตทริบิวต์ cmd ของ genrule โดยมีความแตกต่างดังนี้

  1. ไม่มีการขยายป้ายกำกับฮิวริสติก ระบบจะขยายเฉพาะป้ายกำกับที่ใช้ $(location ...)

  2. ระบบจะใช้การเรียกใช้เพิ่มเติมกับสตริงเพื่อแทนที่การแสดงผลทั้งหมดที่สร้างขึ้นจากแอตทริบิวต์ out_templates ระบบจะแทนที่ $(output out_template) ทั้งหมดด้วยเส้นทางไปยังไฟล์ที่ระบุด้วย label

    เช่น out_template $(ACTION_ID).analysis จับคู่กับ $(output $(ACTION_ID).analysis) ได้

    ผลที่ได้คือ การดำเนินการนี้จะแทนที่เหมือนกับ $(location) แต่มีขอบเขตต่างกัน

out_templates

รายการสตริง ค่าเริ่มต้นคือ []

รายการเทมเพลตสำหรับไฟล์ที่สร้างโดยคำสั่ง extra_action

เทมเพลตสามารถใช้ตัวแปรต่อไปนี้

  • $(ACTION_ID) ซึ่งเป็นรหัสที่ระบุ extra_action นี้โดยไม่ซ้ำกัน ใช้เพื่อสร้างไฟล์เอาต์พุตที่ไม่ซ้ำกัน

requires_action_output

บูลีน ค่าเริ่มต้นคือ False

บ่งบอกว่า extra_action นี้ต้องใช้เอาต์พุตของการดำเนินการเดิมเป็นอินพุตสำหรับ extra_action นี้

เมื่อเป็น "จริง" (ค่าเริ่มต้นคือ "เท็จ") extra_action จะถือว่าเอาต์พุตการดําเนินการเดิมมีให้เป็นส่วนหนึ่งของอินพุต

tools

รายการป้ายกำกับ ค่าเริ่มต้นคือ []

รายการ tool ที่ต้องพึ่งพาสำหรับกฎนี้

ดูข้อมูลเพิ่มเติมได้ที่คำจำกัดความของทรัพยากร Dependencies

ระบบบิลด์จะสร้างข้อกําหนดเบื้องต้นเหล่านี้ก่อนเรียกใช้คําสั่ง extra_action โดยสร้างโดยใช้การกําหนดค่า exec เนื่องจากต้องทํางานเป็นเครื่องมือระหว่างการบิลด์ คุณดูเส้นทางของเป้าหมาย //x:y ของ tools แต่ละรายการได้โดยใช้ $(location //x:y)

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