com.facebook.buck.apple

Class AppleBundle

java.lang.Object

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

com.facebook.buck.apple.AppleBundle

All Implemented Interfaces:

BuildRuleWithBinary, BuildEngineAction, AllowsNonAnnotatedFields, HasRuntimeDeps, BuildRule, HasNameAndType, BinaryBuildRule, NativeTestable, Comparable<BuildRule>

public class AppleBundle
extends AbstractBuildRule
implements NativeTestable, BuildRuleWithBinary, HasRuntimeDeps, BinaryBuildRule

Creates a bundle: a directory containing files and subdirectories, described by an Info.plist.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODE_SIGN_ENTITLEMENTS

Method Summary

Modifier and Type	Method and Description
void	addSwiftStdlibStepIfNeeded(SourcePathResolverAdapter resolver, Path destinationPath, Optional<java.util.function.Supplier<CodeSignIdentity>> codeSignIdentitySupplier, com.google.common.collect.ImmutableList.Builder<Step> stepsBuilder, boolean isForPackaging) A wrapper around AppleResourceProcessing.addSwiftStdlibStepIfNeeded
Optional<AppleDsym>	getAppleDsym()
Optional<BuildRule>	getBinary()
BuildRule	getBinaryBuildRule()
static String	getBinaryName(BuildTarget buildTarget, Optional<String> productName)
SortedSet<BuildRule>	getBuildDeps()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
static Path	getBundleRoot(ProjectFilesystem filesystem, BuildTarget buildTarget, String binaryName, String extension)
Tool	getExecutableCommand(OutputLabel outputLabel) Command to execute the output of this rule.
String	getExtension()
Path	getInfoPlistPath()
Boolean	getIsAppClip()
String	getPlatformName()
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()
Path	getUnzippedOutputFilePathToBinary()
boolean	isCacheable() Whether this BuildRule can be cached.
boolean	isLegacyWatchApp()
boolean	isTestedBy(BuildTarget testRule) Return true if this rule is tested by testTarget, false otherwise.
void	updateBuildRuleResolver(BuildRuleResolver ruleResolver) Updates the BuildRuleResolver and associated objects for this build rule.
static com.google.common.collect.ImmutableMap<String,String>	withDefaults(com.google.common.collect.ImmutableMap<String,String> map, com.google.common.collect.ImmutableMap<String,String> defaults)

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

CODE_SIGN_ENTITLEMENTS

public static final String CODE_SIGN_ENTITLEMENTS

See Also:

Constant Field Values

Method Detail

getBinaryName

public static String getBinaryName(BuildTarget buildTarget,
                                   Optional<String> productName)

getBundleRoot

public static Path getBundleRoot(ProjectFilesystem filesystem,
                                 BuildTarget buildTarget,
                                 String binaryName,
                                 String extension)

getExtension

public String getExtension()

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getInfoPlistPath

public Path getInfoPlistPath()

getUnzippedOutputFilePathToBinary

public Path getUnzippedOutputFilePathToBinary()

getPlatformName

public String getPlatformName()

getBinary

public Optional<BuildRule> getBinary()

getAppleDsym

public Optional<AppleDsym> getAppleDsym()

isLegacyWatchApp

public boolean isLegacyWatchApp()

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

addSwiftStdlibStepIfNeeded

public void addSwiftStdlibStepIfNeeded(SourcePathResolverAdapter resolver,
                                       Path destinationPath,
                                       Optional<java.util.function.Supplier<CodeSignIdentity>> codeSignIdentitySupplier,
                                       com.google.common.collect.ImmutableList.Builder<Step> stepsBuilder,
                                       boolean isForPackaging)

A wrapper around AppleResourceProcessing.addSwiftStdlibStepIfNeeded

withDefaults

public static com.google.common.collect.ImmutableMap<String,String> withDefaults(com.google.common.collect.ImmutableMap<String,String> map,
                                                                                 com.google.common.collect.ImmutableMap<String,String> defaults)

getIsAppClip

public Boolean getIsAppClip()

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

getBinaryBuildRule

public BuildRule getBinaryBuildRule()

Specified by:

getBinaryBuildRule in interface BuildRuleWithBinary

getRuntimeDeps

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

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

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

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

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