// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.rules.extra;
import static com.google.devtools.build.lib.packages.Attribute.attr;
import static com.google.devtools.build.lib.packages.BuildType.LABEL_LIST;
import static com.google.devtools.build.lib.syntax.Type.STRING_LIST;
import com.google.devtools.build.lib.analysis.BaseRuleClasses;
import com.google.devtools.build.lib.analysis.RuleDefinition;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.packages.RuleClass.Builder;
/**
* Rule definition for action_listener rule.
*/
public final class ActionListenerRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
/*
A list of action mnemonics this action_listener
should listen
for, e.g. [ "Javac" ]
.
Mnemonics are not a public interface. There's no guarantee that the mnemonics and their actions don't change.
*/ .add(attr("mnemonics", STRING_LIST).mandatory()) /* A list ofextra_action
targets
this action_listener
should add to the build graph.
E.g. [ "//my/tools:analyzer" ]
.
*/
.add(attr("extra_actions", LABEL_LIST).mandatory()
.allowedRuleClasses("extra_action")
.allowedFileTypes())
.removeAttribute("deps")
.removeAttribute("data")
.removeAttribute(":action_listener")
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("action_listener")
.ancestors(BaseRuleClasses.RuleBase.class)
.factoryClass(ActionListener.class)
.build();
}
}
/*
DISCLAIMER:
This is an experimental feature, expect breaking changes when
implementing an action_listener
/extra_action
.
An action_listener
rule doesn't produce any output itself.
Instead, it allows tool developers to insert
extra_action
s into the build system,
by providing a mapping from action to extra_action
.
This rule's arguments map action mnemonics to
extra_action
rules.
By specifying the option
--experimental_action_listener=<label>
,
the build will use the specified action_listener
to insert
extra_action
s into the build graph.
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)", )*/