Reglas de acciones adicionales

Reglas

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)

ADVERTENCIA: Las acciones adicionales dejaron de estar disponibles. En su lugar, usa aspects.

Una regla action_listener no produce ningún resultado por sí misma. En cambio, permite a los desarrolladores de herramientas insertar extra_action en el sistema de compilación, ya que proporciona una asignación de acción a extra_action .

Los argumentos de esta regla asignan mnemotécnicas de acción a reglas de extra_action.

Si especificas la opción --experimental_action_listener=<label>, la compilación usará el action_listener especificado para insertar extra_action en el gráfico de compilación.

Ejemplo

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

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

extra_actions

List of labels; required

Una lista de destinos de extra_action que esta action_listener debería agregar al gráfico de compilación P.ej., [ "//my/tools:analyzer" ].
mnemonics

List of strings; required

Una lista de mnemotécnicas de acción que action_listener debe escuchar, p.ej., [ "Javac" ].

Los mnemotécnicos no son una interfaz pública. No hay garantía de que los mnemotécnicos y sus acciones no cambien.

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)

ADVERTENCIA: Las acciones adicionales dejaron de estar disponibles. En su lugar, usa aspects.

Una regla extra_action no produce ningún resultado significativo cuando se especifica como un objetivo de compilación normal. En cambio, permite a los desarrolladores de herramientas insertar acciones adicionales en el gráfico de compilación que sustituyen las acciones existentes.

Consulta action_listener para obtener detalles sobre cómo habilitar extra_action.

Los extra_action se ejecutan como una línea de comandos. La herramienta de línea de comandos obtiene acceso a un archivo que contiene un búfer de protocolo como $(EXTRA_ACTION_FILE) con información detallada sobre la acción original que duplica. También tiene acceso a todos los archivos de entrada a los que tiene acceso la acción original. Consulta extra_actions_base.proto para obtener detalles sobre los datos almacenados dentro del búfer de protocolo. Cada archivo proto contiene un mensaje ExtraActionInfo.

Al igual que todas las demás acciones, las acciones adicionales se incluyen en una zona de pruebas y deben diseñarse para manejarlas.

Argumentos

Atributos
name

Name; required

Un nombre único para este destino.

Puedes consultar esta regla con label en el argumento extra_actions de las reglas action_listener.
cmd

String; required

El comando que se ejecutará.

Es similar al atributo cmd genrule, pero con las siguientes diferencias:

  1. Sin expansión de etiquetas heurística. Solo se expanden las etiquetas que utilizan $(location ...).

  2. Se aplica un pase adicional a la string para reemplazar todos los casos de los resultados creados a partir del atributo out_templates. Todos los casos de $(output out_template) se reemplazan por la ruta al archivo indicado por label.

    P.ej., out_template $(ACTION_ID).analysis puede coincidir con $(output $(ACTION_ID).analysis).

    En efecto, esta es la misma sustitución que $(location), pero con un alcance diferente.

out_templates

List of strings; optional

Una lista de plantillas para archivos que genera el comando extra_action.

La plantilla puede usar las siguientes variables:

  • $(ACTION_ID), un ID que identifica de manera inequívoca a extra_action. Se usa para generar un archivo de salida único.

requires_action_output

Boolean; optional; default is False

Indica que esta extra_action requiere que el resultado de la acción original esté presente como entrada en este extra_action.

Cuando es verdadero (de forma predeterminada, falso), extra_action puede suponer que las salidas de la acción original están disponibles como parte de sus entradas.

tools

List of labels; optional

Una lista de tool dependencias para esta regla.

Consulta la definición de dependencias para obtener más información.

El sistema de compilación garantiza que estos requisitos previos se compilen antes de ejecutar el comando extra_action. Se compilan mediante la configuración host, ya que deben ejecutarse como una herramienta durante la compilación. La ruta de un tools objetivo //x:y individual se puede obtener usando $(location //x:y).

Todas las herramientas y sus dependencias de datos se consolidan en un único árbol, dentro del cual el comando puede usar rutas relativas. El directorio de trabajo será la raíz de ese árbol unificado.