com.facebook.buck.cxx

Class CxxStrip

java.lang.Object

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

com.facebook.buck.cxx.CxxStrip

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, Comparable<BuildRule>

public class CxxStrip
extends AbstractBuildRule
implements SupportsInputBasedRuleKey

Controls how strip tool is invoked. To have better understanding please refer to `man strip`. If you don't want stripping, you should depend on CxxLink directly.

Field Summary

Fields

Modifier and Type	Field and Description
static Flavor	RULE_FLAVOR Used to identify this rule in the graph.

Constructor Summary

Constructors

Constructor and Description
CxxStrip(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, SourcePath unstrippedBinary, SourcePathRuleFinder ruleFinder, StripStyle stripStyle, Tool strip, boolean isCacheable, Path output)

Method Summary

Modifier and Type	Method and Description
SortedSet<BuildRule>	getBuildDeps()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
SourcePath	getSourcePathToOutput()
StripStyle	getStripStyle()
boolean	isCacheable() Whether this BuildRule can be cached.
static BuildTarget	removeStripStyleFlavorInTarget(BuildTarget buildTarget, Optional<StripStyle> flavoredStripStyle)
static BuildTarget	restoreStripStyleFlavorInTarget(BuildTarget buildTarget, Optional<StripStyle> flavoredStripStyle)
void	updateBuildRuleResolver(BuildRuleResolver ruleResolver) Updates the BuildRuleResolver and associated objects for this build rule.

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.attr.SupportsInputBasedRuleKey

inputBasedRuleKeyIsEnabled, isSupported

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

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

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

getDependencies, getSourcePathOutputs

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

getType

Field Detail

RULE_FLAVOR

public static final Flavor RULE_FLAVOR

Used to identify this rule in the graph. This should be appended ONLY to build target that is passed to the CxxStrip constructor when you create instance of this class. Appending it in other places is does nothing except adds a unnecessary flavor that will skew output paths of other build rules.

Constructor Detail

CxxStrip

public CxxStrip(BuildTarget buildTarget,
                ProjectFilesystem projectFilesystem,
                SourcePath unstrippedBinary,
                SourcePathRuleFinder ruleFinder,
                StripStyle stripStyle,
                Tool strip,
                boolean isCacheable,
                Path output)

Method Detail

removeStripStyleFlavorInTarget

public static BuildTarget removeStripStyleFlavorInTarget(BuildTarget buildTarget,
                                                         Optional<StripStyle> flavoredStripStyle)

restoreStripStyleFlavorInTarget

public static BuildTarget restoreStripStyleFlavorInTarget(BuildTarget buildTarget,
                                                          Optional<StripStyle> flavoredStripStyle)

getBuildDeps

public SortedSet<BuildRule> getBuildDeps()

Specified by:

getBuildDeps in interface BuildRule

Returns:

the set of rules that must be built before this rule. Normally, this matches the value of the deps argument for this build rule in the build file in which it was defined.

However, there are special cases where other arguments pull in implicit dependencies (e.g., the keystore argument in android_binary). In these cases, the implicit dependencies are also included in the set returned by this method. The value of the original deps argument, as defined in the build file, must be accessed via a custom getter provided by the build rule.

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

getStripStyle

public StripStyle getStripStyle()

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

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

updateBuildRuleResolver

public void updateBuildRuleResolver(BuildRuleResolver ruleResolver)

Description copied from interface: BuildRule

Updates the BuildRuleResolver and associated objects for this build rule.

Build rules sometimes hold field references to build rule resolvers. If this build rule is to be cached, it must update its BuildRuleResolver when a new action graph is constructed to avoid leaking the entire action graph it was originally associated with.

Specified by:

updateBuildRuleResolver in interface BuildRule

Overrides:

updateBuildRuleResolver in class AbstractBuildRule