com.facebook.buck.core.starlark.rule

Class SkylarkDescription

java.lang.Object

com.facebook.buck.core.starlark.rule.SkylarkDescription

All Implemented Interfaces:

BaseDescription<SkylarkDescriptionArg>, Description<SkylarkDescriptionArg>, RuleDescription<SkylarkDescriptionArg>, RuleDescriptionWithInstanceName<SkylarkDescriptionArg>

public class SkylarkDescription
extends Object
implements RuleDescriptionWithInstanceName<SkylarkDescriptionArg>

Description for User Defined Rules. This Description runs user-supplied implementation functions in order to generate Actions.

Constructor Summary

Constructors

Constructor and Description
SkylarkDescription()

Method Summary

Modifier and Type	Method and Description
Class<SkylarkDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
String	getRuleName(SkylarkDescriptionArg args)
boolean	producesCacheableSubgraph() Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.
ProviderInfoCollection	ruleImpl(RuleAnalysisContext context, BuildTarget target, SkylarkDescriptionArg args) Runs the rule implementation during the analysis phase.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.facebook.buck.core.description.BaseDescription

getConfigurationDeps

Constructor Detail

SkylarkDescription

public SkylarkDescription()

Method Detail

producesCacheableSubgraph

public boolean producesCacheableSubgraph()

Description copied from interface: Description

Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.

Specified by:

producesCacheableSubgraph in interface Description<SkylarkDescriptionArg>

Specified by:

producesCacheableSubgraph in interface RuleDescription<SkylarkDescriptionArg>

ruleImpl

public ProviderInfoCollection ruleImpl(RuleAnalysisContext context,
                                       BuildTarget target,
                                       SkylarkDescriptionArg args)
                                throws RuleAnalysisException,
                                       ActionCreationException

Description copied from interface: RuleDescription

Runs the rule implementation during the analysis phase. The rule implementation should create the propagated Providers and corresponding InfoInterfaces, and register its corresponding actions.

Specified by:

ruleImpl in interface RuleDescription<SkylarkDescriptionArg>

Parameters:

context - a RuleAnalysisContext containing all the information usable by this rule for it's analysis and constructive of its corresponding Provider and BuildRule graph.

target - the BuildTarget of this rule

args - The args of type T that this rule uses to rule its analysis

Returns:

a ProviderInfoCollection that contains all the Provider and the corresponding InfoInterface to be propagated by this rule.

Throws:

RuleAnalysisException - If the rule implementation could not run as expected. e.g. if the implementation method of a User Defined Rule fails to eval

ActionCreationException - If an action cannot be created correctly

getRuleName

public String getRuleName(SkylarkDescriptionArg args)

Specified by:

getRuleName in interface RuleDescriptionWithInstanceName<SkylarkDescriptionArg>

Returns:

The user friendly name of a rule. e.g. cxx_binary, or //foo:baz.bzl:some_rule. See DescriptionCache.getRuleType(BaseDescription)

getConstructorArgType

public Class<SkylarkDescriptionArg> getConstructorArgType()

Description copied from interface: BaseDescription

The type of the constructor argument that is used by this description to create a rule

Specified by:

getConstructorArgType in interface BaseDescription<SkylarkDescriptionArg>