com.facebook.buck.cxx

Class CxxPrecompiledHeaderTemplate

java.lang.Object

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

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

com.facebook.buck.core.rules.impl.NoopBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.cxx.PreInclude

com.facebook.buck.cxx.CxxPrecompiledHeaderTemplate

All Implemented Interfaces:

AndroidPackageable, BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, BuildRule, HasNameAndType, CxxPreprocessorDep, NativeLinkableGroup, Comparable<BuildRule>

public class CxxPrecompiledHeaderTemplate
extends PreInclude
implements AndroidPackageable

Represents a precompilable header file, along with dependencies.

Rules which depend on this will inherit this rule's of dependencies. For example if a given rule R uses a precompiled header rule P, then all of P's deps will get merged into R's deps list.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.cxx.toolchain.nativelink.NativeLinkableGroup

NativeLinkableGroup.Linkage

Method Summary

Modifier and Type	Method and Description
void	addToCollector(AndroidPackageableCollector collector) Add concrete resources to the given collector.
com.facebook.buck.cxx.CxxPrecompiledHeader	getPrecompiledHeader(boolean canPrecompile, com.facebook.buck.cxx.PreprocessorDelegate preprocessorDelegateForCxxRule, DependencyAggregation aggregatedPreprocessDepsRule, CxxToolFlags computedCompilerFlags, java.util.function.Function<CxxToolFlags,String> getHash, java.util.function.Function<CxxToolFlags,String> getBaseHash, CxxPlatform cxxPlatform, CxxSource.Type sourceType, com.google.common.collect.ImmutableList<String> sourceFlags, ActionGraphBuilder graphBuilder, SourcePathResolverAdapter pathResolver) Build a PCH rule, given a cxx_precompiled_header rule.
Iterable<AndroidPackageable>	getRequiredPackageables(BuildRuleResolver ruleResolver) Get the set of packagables that need to be included in any package that includes this object.

Methods inherited from class com.facebook.buck.cxx.PreInclude

buildPreprocessorDelegate, getAbsoluteHeaderPath, getCxxPreprocessorDeps, getCxxPreprocessorInput, getHeaderSourcePath, getNativeLinkable, getRelativeHeaderPath, getTransitiveCxxPreprocessorInput, requireAggregatedDepsRule, requirePrecompiledHeader

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

getBuildSteps, getSourcePathToOutput, hasBuildSteps, isCacheable

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, 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.cxx.toolchain.nativelink.NativeLinkableGroup

getBuildTarget

Methods inherited from interface com.facebook.buck.cxx.CxxPreprocessorDep

getBuildTarget

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

compareTo, getFullyQualifiedName, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Method Detail

getPrecompiledHeader

public com.facebook.buck.cxx.CxxPrecompiledHeader getPrecompiledHeader(boolean canPrecompile,
                                                                       com.facebook.buck.cxx.PreprocessorDelegate preprocessorDelegateForCxxRule,
                                                                       DependencyAggregation aggregatedPreprocessDepsRule,
                                                                       CxxToolFlags computedCompilerFlags,
                                                                       java.util.function.Function<CxxToolFlags,String> getHash,
                                                                       java.util.function.Function<CxxToolFlags,String> getBaseHash,
                                                                       CxxPlatform cxxPlatform,
                                                                       CxxSource.Type sourceType,
                                                                       com.google.common.collect.ImmutableList<String> sourceFlags,
                                                                       ActionGraphBuilder graphBuilder,
                                                                       SourcePathResolverAdapter pathResolver)

Build a PCH rule, given a cxx_precompiled_header rule.

We'll "instantiate" this PCH from this template, using the parameters (src, dependencies) from the template itself, plus the build flags that are used in the current build rule (so that this instantiated version uses compatible build flags and thus the PCH is guaranteed usable with this rule).

Specified by:

getPrecompiledHeader in class PreInclude

getRequiredPackageables

public Iterable<AndroidPackageable> getRequiredPackageables(BuildRuleResolver ruleResolver)

Description copied from interface: AndroidPackageable

Get the set of packagables that need to be included in any package that includes this object.

For example, an android_library will need all of its Java deps (except provided_deps), its resource deps, and its native library deps (even though it doesn't need the native library as a build-time dependency). An android_resource might need an android_library that declares a custom view that it references, as well as other android_resource rules that it references directly.

TODO(natthu): Once build rules and buildables are merged, replace this method with another interface that lets an AndroidPackageable override the default set which is all deps of the type AndroidPackageable.

Specified by:

getRequiredPackageables in interface AndroidPackageable

Returns:

All AndroidPackageables that must be included along with this one.

addToCollector

public void addToCollector(AndroidPackageableCollector collector)

Description copied from interface: AndroidPackageable

Add concrete resources to the given collector.

Implementations should call methods on the collector specify what concrete content must be included in an Android package that includes this object. For example, an android_library will add Java classes, an ndk_library will add native libraries, and android_resource will add resource directories.

Specified by:

addToCollector in interface AndroidPackageable

Parameters:

collector - The AndroidPackageableCollector that will receive the content.