com.facebook.buck.core.toolchain.rule

Class LegacyToolchainRuleDescription

java.lang.Object

com.facebook.buck.core.toolchain.rule.LegacyToolchainRuleDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<LegacyToolchainDescriptionArg>, BaseDescription<LegacyToolchainDescriptionArg>, Description<LegacyToolchainDescriptionArg>, RuleDescription<LegacyToolchainDescriptionArg>

public class LegacyToolchainRuleDescription
extends Object
implements RuleDescription<LegacyToolchainDescriptionArg>, ImplicitDepsInferringDescription<LegacyToolchainDescriptionArg>

Description that wraps legacy toolchains by name. e.g. to allow access to .NET toolchains without having to re-implement them.

'legacy' toolchains are ones that may do extra work behind the scenes in a way that is not directly able to be represented by Rule Analysis. This might be something like looking at the local environment, finding executables on the system path, etc. They are also used to minimmize the amount of porting work that has to be done up-front. Old rules can continue to use old toolchain retreival methods like ToolchainProvider.getByName(String, TargetConfiguration), whereas new UDR/RAG rules can have a clean interface where Provider instances do all necessary communication about toolchains.

We expose these currently so that new rules can use existing compilers, tools, etc. However in the future, these should be discarded in favor of proper build rules that only exist in RAG/UDR.

Constructor Summary

Constructors

Constructor and Description
LegacyToolchainRuleDescription(ToolchainProvider toolchainProvider)

Method Summary

Modifier and Type	Method and Description
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, LegacyToolchainDescriptionArg constructorArg, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)
Class<LegacyToolchainDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
ProviderInfoCollection	ruleImpl(RuleAnalysisContext context, BuildTarget target, LegacyToolchainDescriptionArg 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.RuleDescription

producesCacheableSubgraph

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

getConfigurationDeps

Constructor Detail

LegacyToolchainRuleDescription

public LegacyToolchainRuleDescription(ToolchainProvider toolchainProvider)

Method Detail

ruleImpl

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

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<LegacyToolchainDescriptionArg>

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:

ActionCreationException - If an action cannot be created correctly

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

getConstructorArgType

public Class<LegacyToolchainDescriptionArg> 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<LegacyToolchainDescriptionArg>

findDepsForTargetFromConstructorArgs

public void findDepsForTargetFromConstructorArgs(BuildTarget buildTarget,
                                                 CellNameResolver cellRoots,
                                                 LegacyToolchainDescriptionArg constructorArg,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)

Specified by:

findDepsForTargetFromConstructorArgs in interface ImplicitDepsInferringDescription<LegacyToolchainDescriptionArg>