com.facebook.buck.cxx

Class CxxLink

java.lang.Object

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

com.facebook.buck.rules.modern.ModernBuildRule<CxxLink.Impl>

com.facebook.buck.cxx.CxxLink

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, HasSupplementaryOutputs, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, OverrideScheduleRule, HasAppleDebugSymbolDeps, Comparable<BuildRule>

public class CxxLink
extends ModernBuildRule<CxxLink.Impl>
implements HasAppleDebugSymbolDeps, OverrideScheduleRule, HasSupplementaryOutputs

A BuildRule for linking c++ objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CxxLink.Impl Buildable implementation of CxxLink.

Constructor Summary

Constructors

Constructor and Description

CxxLink(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, SourcePathRuleFinder ruleFinder, CellPathResolver cellResolver, Linker linker, Path output, com.google.common.collect.ImmutableMap<String,Path> extraOutputs, com.google.common.collect.ImmutableList<Arg> args, Optional<LinkOutputPostprocessor> postprocessor, Optional<RuleScheduleInfo> ruleScheduleInfo, boolean cacheable, boolean thinLto, boolean fatLto)

Method Summary

Modifier and Type	Method and Description
java.util.stream.Stream<BuildRule>	getAppleDebugSymbolDeps()
com.google.common.collect.ImmutableList<Arg>	getArgs()
Linker	getLinker()
Optional<Path>	getLinkerMapPath()
RuleScheduleInfo	getRuleScheduleInfo()
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.

Methods inherited from class com.facebook.buck.rules.modern.ModernBuildRule

compareTo, getBuildable, getBuildCellPathFactory, getBuildDeps, getBuildSteps, getOutputPathResolver, getSetupStepsForBuildable, getSourcePath, getSourcePaths, injectFieldsIfNecessary, inputBasedRuleKeyIsEnabled, recordOutputs, recordOutputs, recordOutputs, stepsForBuildable, stepsForBuildable, updateBuildRuleResolver

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

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

Methods inherited from class java.lang.Object

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

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

compareTo, getBuildDeps, getBuildSteps, 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

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

isSupported

Constructor Detail

CxxLink

public CxxLink(BuildTarget buildTarget,
               ProjectFilesystem projectFilesystem,
               SourcePathRuleFinder ruleFinder,
               CellPathResolver cellResolver,
               Linker linker,
               Path output,
               com.google.common.collect.ImmutableMap<String,Path> extraOutputs,
               com.google.common.collect.ImmutableList<Arg> args,
               Optional<LinkOutputPostprocessor> postprocessor,
               Optional<RuleScheduleInfo> ruleScheduleInfo,
               boolean cacheable,
               boolean thinLto,
               boolean fatLto)

Method Detail

getAppleDebugSymbolDeps

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

Specified by:

getAppleDebugSymbolDeps in interface HasAppleDebugSymbolDeps

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

Overrides:

getSourcePathToOutput in class ModernBuildRule<CxxLink.Impl>

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

getRuleScheduleInfo

public RuleScheduleInfo getRuleScheduleInfo()

Specified by:

getRuleScheduleInfo in interface OverrideScheduleRule

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

getLinkerMapPath

public Optional<Path> getLinkerMapPath()

getLinker

public Linker getLinker()

getArgs

public com.google.common.collect.ImmutableList<Arg> getArgs()