com.facebook.buck.apple

Class AppleDsym

java.lang.Object

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

com.facebook.buck.apple.AppleDsym

All Implemented Interfaces:

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

public class AppleDsym
extends AbstractBuildRule
implements HasPostBuildSteps, SupportsInputBasedRuleKey

Creates dSYM bundle for the given _unstripped_ binary.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DSYM_DWARF_FILE_FOLDER
static Flavor	RULE_FLAVOR

Constructor Summary

Constructors

Constructor and Description
AppleDsym(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, SourcePathRuleFinder sourcePathRuleFinder, Tool dsymutil, Tool lldb, SourcePath unstrippedBinarySourcePath, com.google.common.collect.ImmutableSortedSet<SourcePath> additionalSymbolDeps, Path dsymOutputPath, boolean isCacheable)

Method Summary

Modifier and Type	Method and Description
SortedSet<BuildRule>	getBuildDeps()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
static Path	getDsymOutputPath(BuildTarget target, ProjectFilesystem filesystem)
static String	getDwarfFilenameForDsymTarget(BuildTarget dsymTarget)
com.google.common.collect.ImmutableList<Step>	getPostBuildSteps(BuildContext context)
SourcePath	getSourcePathToOutput()
boolean	isCacheable() Whether this BuildRule can be cached.
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

DSYM_DWARF_FILE_FOLDER

public static final String DSYM_DWARF_FILE_FOLDER

See Also:

Constant Field Values

Constructor Detail

AppleDsym

public AppleDsym(BuildTarget buildTarget,
                 ProjectFilesystem projectFilesystem,
                 SourcePathRuleFinder sourcePathRuleFinder,
                 Tool dsymutil,
                 Tool lldb,
                 SourcePath unstrippedBinarySourcePath,
                 com.google.common.collect.ImmutableSortedSet<SourcePath> additionalSymbolDeps,
                 Path dsymOutputPath,
                 boolean isCacheable)

Method Detail

getDsymOutputPath

public static Path getDsymOutputPath(BuildTarget target,
                                     ProjectFilesystem filesystem)

getDwarfFilenameForDsymTarget

public static String getDwarfFilenameForDsymTarget(BuildTarget dsymTarget)

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

getPostBuildSteps

public com.google.common.collect.ImmutableList<Step> getPostBuildSteps(BuildContext context)

Specified by:

getPostBuildSteps in interface HasPostBuildSteps

Returns:

a list of Steps that run after the build regardless of whether this build rule actually ran or hit in the cache.

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.

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

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