implementation function when "
+ "you create a rule."
)
public final class SkylarkRuleContext implements SkylarkValue {
private static final String DOC_NEW_FILE_TAIL = "Does not actually create a file on the file "
+ "system, just declares that some action will do so. You must create an action that "
+ "generates the file. If the file should be visible to other rules, declare a rule output "
+ "instead when possible. Doing so enables Blaze to associate a label with the file that "
+ "rules can refer to (allowing finer dependency control) instead of referencing the whole "
+ "rule.";
public static final String EXECUTABLE_DOC =
"A struct containing executable files defined in label type "
+ "attributes marked as executable=True. The struct fields correspond "
+ "to the attribute names. Each value in the struct is either a file or "
+ "None. If an optional attribute is not specified in the rule "
+ "then the corresponding struct value is None. If a label type is not "
+ "marked as executable=True, no corresponding struct field is generated.";
public static final String FILES_DOC =
"A struct containing files defined in label or label list "
+ "type attributes. The struct fields correspond to the attribute names. The struct "
+ "values are list of files. If an optional attribute is "
+ "not specified in the rule, an empty list is generated. "
+ "It is a shortcut for:"
+ "[f for t in ctx.attr.<ATTR> for f in t.files]"; public static final String FILE_DOC = "A
struct containing files defined in label type "
+ "attributes marked as single_file=True. The struct fields correspond "
+ "to the attribute names. The struct value is always a file or "
+ "None. If an optional attribute is not specified in the rule "
+ "then the corresponding struct value is None. If a label type is not "
+ "marked as single_file=True, no corresponding struct field is generated. "
+ "It is a shortcut for:"
+ "list(ctx.attr.<ATTR>.files)[0]"; public static final String ATTR_DOC = "A struct to access the values of the attributes. The values are provided by " + "the user (if not, a default value is used)."; public static final String SPLIT_ATTR_DOC = "A struct to access the values of attributes with split configurations. If the attribute is " + "a label list, the value of split_attr is a dict of the keys of the split (as strings) " + "to lists of the ConfiguredTargets in that branch of the split. If the attribute is a " + "label, then the value of split_attr is a dict of the keys of the split (as strings) " + "to single ConfiguredTargets. Attributes with split configurations still appear in the " + "attr struct, but their values will be single lists with all the branches of the split " + "merged together."; public static final String OUTPUTS_DOC = "A
struct containing all the output files."
+ " The struct is generated the following way:executable=True the struct has an "
+ "\"executable\" field with the rules default executable file value."
+ "outputs dict an attr is generated with "
+ "the same name and the corresponding file value."
+ "file value or None, "
+ "if no value is specified in the rule."
+ "list of files value "
+ "(an empty list if no value is specified in the rule).null
* if it is for a rule.
* @throws InterruptedException
*/
public SkylarkRuleContext(RuleContext ruleContext,
@Nullable AspectDescriptor aspectDescriptor)
throws EvalException, InterruptedException {
this.ruleContext = Preconditions.checkNotNull(ruleContext);
this.ruleLabelCanonicalName = ruleContext.getLabel().getCanonicalForm();
this.fragments = new FragmentCollection(ruleContext, ConfigurationTransition.NONE);
this.hostFragments = new FragmentCollection(ruleContext, ConfigurationTransition.HOST);
this.aspectDescriptor = aspectDescriptor;
if (aspectDescriptor == null) {
Collectiondefault_provider accepts all special parameters that can be returned "
+ "from rule implementation function in a struct, which are runfiles, "
+ "data_runfiles, default_runfiles, "
+ "output_groups, instrumented_files, and all "
+ "providers that are available on built-in rules.")
public static ClassObjectConstructor getDefaultProvider() {
return DEFAULT_PROVIDER;
}
@SkylarkCallable(name = "created_actions",
doc = "For rules with _skylark_testable"
+ " set to True, this returns an "
+ "Actions provider representing all actions "
+ "created so far for the current rule. For all other rules, returns None. "
+ "Note that the provider is not updated when subsequent actions are created, so you "
+ "will have to call this function again if you wish to inspect them. "
+ "ctx object and create actions on it.")
public Object createdActions() throws EvalException {
checkMutable("created_actions");
if (ruleContext.getRule().getRuleClassObject().isSkylarkTestable()) {
return ActionsProvider.create(
ruleContext.getAnalysisEnvironment().getRegisteredActions());
} else {
return Runtime.NONE;
}
}
@SkylarkCallable(name = "attr", structField = true, doc = ATTR_DOC)
public SkylarkClassObject getAttr() throws EvalException {
checkMutable("attr");
return attributesCollection.getAttr();
}
@SkylarkCallable(name = "split_attr", structField = true, doc = SPLIT_ATTR_DOC)
public SkylarkClassObject getSplitAttr() throws EvalException {
checkMutable("split_attr");
if (splitAttributes == null) {
throw new EvalException(
Location.BUILTIN, "'split_attr' is available only in rule implementations");
}
return splitAttributes;
}
/**
* See {@link RuleContext#getExecutablePrerequisite(String, Mode)}.
*/
@SkylarkCallable(name = "executable", structField = true, doc = EXECUTABLE_DOC)
public SkylarkClassObject getExecutable() throws EvalException {
checkMutable("executable");
return attributesCollection.getExecutable();
}
/**
* See {@link RuleContext#getPrerequisiteArtifact(String, Mode)}.
*/
@SkylarkCallable(name = "file", structField = true, doc = FILE_DOC)
public SkylarkClassObject getFile() throws EvalException {
checkMutable("file");
return attributesCollection.getFile();
}
/**
* See {@link RuleContext#getPrerequisiteArtifacts(String, Mode)}.
*/
@SkylarkCallable(name = "files", structField = true, doc = FILES_DOC)
public SkylarkClassObject getFiles() throws EvalException {
checkMutable("files");
return attributesCollection.getFiles();
}
@SkylarkCallable(name = "workspace_name", structField = true,
doc = "Returns the workspace name as defined in the WORKSPACE file.")
public String getWorkspaceName() throws EvalException {
checkMutable("workspace_name");
return ruleContext.getWorkspaceName();
}
@SkylarkCallable(name = "label", structField = true, doc = "The label of this rule.")
public Label getLabel() throws EvalException {
checkMutable("label");
return ruleContext.getLabel();
}
@SkylarkCallable(name = "fragments", structField = true,
doc = "Allows access to configuration fragments in target configuration.")
public FragmentCollection getFragments() throws EvalException {
checkMutable("fragments");
return fragments;
}
@SkylarkCallable(name = "host_fragments", structField = true,
doc = "Allows access to configuration fragments in host configuration.")
public FragmentCollection getHostFragments() throws EvalException {
checkMutable("host_fragments");
return hostFragments;
}
@SkylarkCallable(name = "configuration", structField = true,
doc = "Returns the default configuration. See the "
+ "configuration type for more details.")
public BuildConfiguration getConfiguration() throws EvalException {
checkMutable("configuration");
return ruleContext.getConfiguration();
}
@SkylarkCallable(name = "host_configuration", structField = true,
doc = "Returns the host configuration. See the "
+ "configuration type for more details.")
public BuildConfiguration getHostConfiguration() throws EvalException {
checkMutable("host_configuration");
return ruleContext.getHostConfiguration();
}
@SkylarkCallable(name = "coverage_instrumented",
doc = "Returns whether code coverage instrumentation should be generated when performing "
+ "compilation actions for this rule or, if target is provided, the rule "
+ "specified by that Target. (If a non-rule Target is provided, this returns False.) This "
+ "differs from coverage_enabled in the "
+ "configuration, which notes whether coverage data collection is enabled for the "
+ "entire run, but not whether a specific target should be instrumented.",
parameters = {
@Param(
name = "target",
type = TransitiveInfoCollection.class,
defaultValue = "None",
noneable = true,
named = true,
doc = "A Target specifying a rule. If not provided, defaults to the current rule.")
})
public boolean instrumentCoverage(Object targetUnchecked) throws EvalException {
checkMutable("coverage_instrumented");
BuildConfiguration config = ruleContext.getConfiguration();
if (!config.isCodeCoverageEnabled()) {
return false;
}
if (targetUnchecked == Runtime.NONE) {
return InstrumentedFilesCollector.shouldIncludeLocalSources(ruleContext);
}
TransitiveInfoCollection target = (TransitiveInfoCollection) targetUnchecked;
return (target.getProvider(InstrumentedFilesProvider.class) != null)
&& InstrumentedFilesCollector.shouldIncludeLocalSources(config, target);
}
@SkylarkCallable(name = "features", structField = true,
doc = "Returns the set of features that are enabled for this rule."
)
public ImmutableList