com.facebook.buck.cxx.toolchain

Class HeaderSymlinkTree

java.lang.Object

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

com.facebook.buck.core.rules.impl.SymlinkTree

com.facebook.buck.core.rules.impl.MappedSymlinkTree

com.facebook.buck.cxx.toolchain.HeaderSymlinkTree

All Implemented Interfaces:

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

Direct Known Subclasses:

HeaderSymlinkTreeWithHeaderMap, HeaderSymlinkTreeWithModuleMap

public class HeaderSymlinkTree
extends MappedSymlinkTree

Field Summary

Fields inherited from class com.facebook.buck.core.rules.impl.SymlinkTree

category, root, type

Constructor Summary

Constructors

Constructor and Description
HeaderSymlinkTree(BuildTarget target, ProjectFilesystem filesystem, Path root, com.google.common.collect.ImmutableMap<Path,SourcePath> links)

Method Summary

Modifier and Type	Method and Description
Optional<SourcePath>	getHeaderMapSourcePath()
PathSourcePath	getIncludeSourcePath() Get path to use as an include path to get access to the files in the tree.

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

getLinks

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

getBuildDeps, getBuildSteps, getResolvedSymlinks, getRoot, getRootSourcePath, getRuntimeDeps, getSourcePathToOutput, getType, getVerifyStep, isCacheable, resolveDuplicateRelativePaths, shouldDeleteExistingSymlink

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

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, 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.attr.SupportsInputBasedRuleKey

inputBasedRuleKeyIsEnabled, isSupported

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

Constructor Detail

HeaderSymlinkTree

public HeaderSymlinkTree(BuildTarget target,
                         ProjectFilesystem filesystem,
                         Path root,
                         com.google.common.collect.ImmutableMap<Path,SourcePath> links)

Method Detail

getIncludeSourcePath

public PathSourcePath getIncludeSourcePath()

Get path to use as an include path to get access to the files in the tree.

If getHeaderMapSourcePath() is present, then the path it returns needs to be passed as an include path as well and it has to be passed before the path returned from this method.

This path should not be added to rulekeys as a SourcePath (in some cases it points to the entire buck-out).

getHeaderMapSourcePath

public Optional<SourcePath> getHeaderMapSourcePath()