com.facebook.buck.cxx

Class PreInclude

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CxxPrecompiledHeaderTemplate, CxxPrefixHeader

public abstract class PreInclude
extends NoopBuildRuleWithDeclaredAndExtraDeps
implements NativeLinkableGroup, CxxPreprocessorDep

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
protected com.facebook.buck.cxx.PreprocessorDelegate	buildPreprocessorDelegate(CxxPlatform cxxPlatform, Preprocessor preprocessor, CxxToolFlags preprocessorFlags, ActionGraphBuilder graphBuilder, SourcePathResolverAdapter pathResolver)
Path	getAbsoluteHeaderPath()
Iterable<CxxPreprocessorDep>	getCxxPreprocessorDeps(CxxPlatform cxxPlatform, BuildRuleResolver ruleResolver)
CxxPreprocessorInput	getCxxPreprocessorInput(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Returns the preprocessor input that represents this rule's public (exported) declarations.
SourcePath	getHeaderSourcePath()
NativeLinkable	getNativeLinkable(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder)
abstract 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)
Path	getRelativeHeaderPath(ProjectFilesystem relativizedTo)
com.google.common.collect.ImmutableMap<BuildTarget,CxxPreprocessorInput>	getTransitiveCxxPreprocessorInput(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Returns all transitive preprocessor inputs for this library.
protected DependencyAggregation	requireAggregatedDepsRule(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Find or create a DependencyAggregation rule, representing a grouping of dependencies: generally, those deps from the current CxxPlatform.
protected com.facebook.buck.cxx.CxxPrecompiledHeader	requirePrecompiledHeader(boolean canPrecompile, com.facebook.buck.cxx.PreprocessorDelegate preprocessorDelegate, CxxPlatform cxxPlatform, CxxSource.Type sourceType, CxxToolFlags compilerFlags, DepsBuilder depsBuilder, BuildTarget buildTarget, ActionGraphBuilder graphBuilder) Look up or build a precompiled header build rule which this build rule is requesting.

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

getHeaderSourcePath

public SourcePath getHeaderSourcePath()

Returns:

source path as specified in a cxx_precompiled_header's src attribute, or of a rule's prefix_header.

getAbsoluteHeaderPath

public Path getAbsoluteHeaderPath()

Returns:

path to the header file, guaranteed absolute

getRelativeHeaderPath

public Path getRelativeHeaderPath(ProjectFilesystem relativizedTo)

Returns:

path to the header file, relativized against the given project filesystem (cell)

getNativeLinkable

public NativeLinkable getNativeLinkable(CxxPlatform cxxPlatform,
                                        ActionGraphBuilder graphBuilder)

Specified by:

getNativeLinkable in interface NativeLinkableGroup

getCxxPreprocessorDeps

public Iterable<CxxPreprocessorDep> getCxxPreprocessorDeps(CxxPlatform cxxPlatform,
                                                           BuildRuleResolver ruleResolver)

Specified by:

getCxxPreprocessorDeps in interface CxxPreprocessorDep

getCxxPreprocessorInput

public CxxPreprocessorInput getCxxPreprocessorInput(CxxPlatform cxxPlatform,
                                                    ActionGraphBuilder graphBuilder)

Description copied from interface: CxxPreprocessorDep

Returns the preprocessor input that represents this rule's public (exported) declarations. This includes any exported preprocessor flags, headers, etc.

Specified by:

getCxxPreprocessorInput in interface CxxPreprocessorDep

getTransitiveCxxPreprocessorInput

public com.google.common.collect.ImmutableMap<BuildTarget,CxxPreprocessorInput> getTransitiveCxxPreprocessorInput(CxxPlatform cxxPlatform,
                                                                                                                  ActionGraphBuilder graphBuilder)

Description copied from interface: CxxPreprocessorDep

Returns all transitive preprocessor inputs for this library. This includes public headers (and exported preprocessor flags) of all exported dependencies.

Specified by:

getTransitiveCxxPreprocessorInput in interface CxxPreprocessorDep

requireAggregatedDepsRule

protected DependencyAggregation requireAggregatedDepsRule(CxxPlatform cxxPlatform,
                                                          ActionGraphBuilder graphBuilder)

Find or create a DependencyAggregation rule, representing a grouping of dependencies: generally, those deps from the current CxxPlatform.

buildPreprocessorDelegate

protected com.facebook.buck.cxx.PreprocessorDelegate buildPreprocessorDelegate(CxxPlatform cxxPlatform,
                                                                               Preprocessor preprocessor,
                                                                               CxxToolFlags preprocessorFlags,
                                                                               ActionGraphBuilder graphBuilder,
                                                                               SourcePathResolverAdapter pathResolver)

Returns:

newly-built delegate for this PCH build (if precompiling enabled)

getPrecompiledHeader

public abstract 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)

requirePrecompiledHeader

protected com.facebook.buck.cxx.CxxPrecompiledHeader requirePrecompiledHeader(boolean canPrecompile,
                                                                              com.facebook.buck.cxx.PreprocessorDelegate preprocessorDelegate,
                                                                              CxxPlatform cxxPlatform,
                                                                              CxxSource.Type sourceType,
                                                                              CxxToolFlags compilerFlags,
                                                                              DepsBuilder depsBuilder,
                                                                              BuildTarget buildTarget,
                                                                              ActionGraphBuilder graphBuilder)

Look up or build a precompiled header build rule which this build rule is requesting.

This method will first try to determine whether a matching PCH was already created; if so, it will be reused. This is done by searching the cache in the ActionGraphBuilder owned by this class. If this ends up building a new instance of CxxPrecompiledHeader, it will be added to the graphBuilder cache.