com.facebook.buck.cxx

Class CxxCompilationDatabase

java.lang.Object

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

com.facebook.buck.cxx.CxxCompilationDatabase

All Implemented Interfaces:

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

public class CxxCompilationDatabase
extends AbstractBuildRule
implements HasRuntimeDeps

Field Summary

Fields

Modifier and Type	Field and Description
static Flavor	COMPILATION_DATABASE
static Flavor	UBER_COMPILATION_DATABASE

Method Summary

Modifier and Type	Method and Description
static CxxCompilationDatabase	createCompilationDatabase(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, Iterable<CxxPreprocessAndCompile> compileAndPreprocessRules)
com.google.common.collect.ImmutableSortedSet<BuildRule>	getBuildDeps()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
SourcePath	getSourcePathToOutput()
boolean	isCacheable() Whether this BuildRule can be cached.

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

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, 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.core.rules.BuildRule

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

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

COMPILATION_DATABASE

public static final Flavor COMPILATION_DATABASE

UBER_COMPILATION_DATABASE

public static final Flavor UBER_COMPILATION_DATABASE

Method Detail

createCompilationDatabase

public static CxxCompilationDatabase createCompilationDatabase(BuildTarget buildTarget,
                                                               ProjectFilesystem projectFilesystem,
                                                               Iterable<CxxPreprocessAndCompile> compileAndPreprocessRules)

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

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

getBuildDeps

public com.google.common.collect.ImmutableSortedSet<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.

getRuntimeDeps

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

Specified by:

getRuntimeDeps in interface HasRuntimeDeps