com.facebook.buck.cxx

Class CxxBinary

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.cxx.CxxBinary

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, HasRuntimeDeps, HasSupplementaryOutputs, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, BinaryBuildRule, HasAppleDebugSymbolDeps, NativeTestable, Comparable<BuildRule>

public class CxxBinary
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements BinaryBuildRule, NativeTestable, HasRuntimeDeps, HasAppleDebugSymbolDeps, SupportsInputBasedRuleKey, HasSupplementaryOutputs

Constructor Summary

Constructors

Constructor and Description
CxxBinary(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, CxxPlatform cxxPlatform, BuildRule linkRule, Tool executable, Iterable<FrameworkPath> frameworks, Iterable<BuildTarget> tests, BuildTarget platformlessTarget, boolean cacheable)

Method Summary

Modifier and Type	Method and Description
java.util.stream.Stream<BuildRule>	getAppleDebugSymbolDeps()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
CxxPlatform	getCxxPlatform()
Tool	getExecutableCommand(OutputLabel outputLabel) Command to execute the output of this rule.
BuildRule	getLinkRule()
CxxPreprocessorInput	getPrivateCxxPreprocessorInput(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Return the CxxPreprocessorInput to expose private headers of this rule.
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
SourcePath	getSourcePathToOutput()
SourcePath	getSourcePathToSupplementaryOutput(String name) Returns a SourcePath to a named supplementary output, or null if it does not exist.
boolean	isCacheable() Whether this BuildRule can be cached.
boolean	isTestedBy(BuildTarget testRule) Return true if this rule is tested by testTarget, false otherwise.

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

deprecatedGetExtraDeps, getBuildDeps, getDeclaredDeps, getTargetGraphOnlyDeps

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRule

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, hashCode, injectFields, toString, updateBuildRuleResolver

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.core.rules.attr.SupportsInputBasedRuleKey

inputBasedRuleKeyIsEnabled, isSupported

Methods inherited from interface com.facebook.buck.core.rules.BuildRule

compareTo, getBuildDeps, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, hasBuildSteps, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString, updateBuildRuleResolver

Methods inherited from interface com.facebook.buck.core.build.action.BuildEngineAction

getDependencies, getSourcePathOutputs

Methods inherited from interface com.facebook.buck.core.rules.HasNameAndType

getType

Constructor Detail

CxxBinary

public CxxBinary(BuildTarget buildTarget,
                 ProjectFilesystem projectFilesystem,
                 BuildRuleParams params,
                 CxxPlatform cxxPlatform,
                 BuildRule linkRule,
                 Tool executable,
                 Iterable<FrameworkPath> frameworks,
                 Iterable<BuildTarget> tests,
                 BuildTarget platformlessTarget,
                 boolean cacheable)

Method Detail

getExecutableCommand

public Tool getExecutableCommand(OutputLabel outputLabel)

Description copied from interface: BinaryBuildRule

Command to execute the output of this rule.

Specified by:

getExecutableCommand in interface BinaryBuildRule

Parameters:

outputLabel - associated with the executable

getBuildSteps

public com.google.common.collect.ImmutableList<Step> getBuildSteps(BuildContext context,
                                                                   BuildableContext buildableContext)

Specified by:

getBuildSteps in interface BuildRule

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getLinkRule

public BuildRule getLinkRule()

isTestedBy

public boolean isTestedBy(BuildTarget testRule)

Description copied from interface: NativeTestable

Return true if this rule is tested by testTarget, false otherwise.

Specified by:

isTestedBy in interface NativeTestable

getPrivateCxxPreprocessorInput

public CxxPreprocessorInput getPrivateCxxPreprocessorInput(CxxPlatform cxxPlatform,
                                                           ActionGraphBuilder graphBuilder)

Description copied from interface: NativeTestable

Return the CxxPreprocessorInput to expose private headers of this rule. This is used to propagate private headers to the test testing this object. For convenience, tests can see private headers visible in the rule being tested.

Specified by:

getPrivateCxxPreprocessorInput in interface NativeTestable

getAppleDebugSymbolDeps

public java.util.stream.Stream<BuildRule> getAppleDebugSymbolDeps()

Specified by:

getAppleDebugSymbolDeps in interface HasAppleDebugSymbolDeps

isCacheable

public boolean isCacheable()

Description copied from interface: BuildRule

Whether this BuildRule can be cached.

Uncached build rules are never written out to cache, never read from cache, and does not count in cache statistics. This rule is useful for artifacts which cannot be easily normalized.

Uncached rules are not always rebuilt, however, as long as the existing on-disk representation is up to date. This means that these rules can take advantage of SupportsInputBasedRuleKey to prevent rebuilding.

Specified by:

isCacheable in interface BuildEngineAction

Specified by:

isCacheable in interface BuildRule

Overrides:

isCacheable in class AbstractBuildRule

getRuntimeDeps

public java.util.stream.Stream<BuildTarget> getRuntimeDeps(BuildRuleResolver buildRuleResolver)

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

getCxxPlatform

public CxxPlatform getCxxPlatform()

getSourcePathToSupplementaryOutput

@Nullable
public SourcePath getSourcePathToSupplementaryOutput(String name)

Description copied from interface: HasSupplementaryOutputs

Returns a SourcePath to a named supplementary output, or null if it does not exist.

Specified by:

getSourcePathToSupplementaryOutput in interface HasSupplementaryOutputs