com.facebook.buck.cxx

Class CxxSymlinkTreeHeaders

java.lang.Object

com.facebook.buck.cxx.CxxHeaders

com.facebook.buck.cxx.CxxSymlinkTreeHeaders

All Implemented Interfaces:

AddsToRuleKey, HasCustomDepsLogic, RuleKeyAppendable

public abstract class CxxSymlinkTreeHeaders
extends CxxHeaders
implements RuleKeyAppendable

Encapsulates headers modeled using a HeaderSymlinkTree.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.rules.keys.RuleKeyAppendable

RuleKeyAppendable.RuleKeyAppendableSink

Constructor Summary

Constructors

Constructor and Description
CxxSymlinkTreeHeaders()

Method Summary

Modifier and Type	Method and Description
void	addToHeaderPathNormalizer(com.facebook.buck.cxx.HeaderPathNormalizer.Builder builder) Add this header pack to the given HeaderPathNormalizer.Builder.
void	appendToRuleKey(RuleKeyAppendable.RuleKeyAppendableSink sink) Deprecated.
static CxxSymlinkTreeHeaders	from(HeaderSymlinkTree symlinkTree, CxxPreprocessables.IncludeType includeType)
java.util.stream.Stream<BuildRule>	getDeps(SourcePathRuleFinder ruleFinder)
abstract Optional<SourcePath>	getHeaderMap()
abstract Either<PathSourcePath,SourcePath>	getIncludeRoot()
abstract CxxPreprocessables.IncludeType	getIncludeType()
abstract com.google.common.collect.ImmutableSortedMap<Path,SourcePath>	getNameToPathMap()
Optional<Path>	getResolvedIncludeRoot(SourcePathResolverAdapter resolver)
abstract SourcePath	getRoot()
abstract String	getSymlinkTreeClass()
static CxxSymlinkTreeHeaders	of(CxxPreprocessables.IncludeType includeType, SourcePath root, Either<PathSourcePath,SourcePath> includeRoot, Optional<? extends SourcePath> headerMap, com.google.common.collect.ImmutableSortedMap<Path,SourcePath> nameToPathMap, String symlinkTreeClass)

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

getArgs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CxxSymlinkTreeHeaders

public CxxSymlinkTreeHeaders()

Method Detail

getIncludeType

public abstract CxxPreprocessables.IncludeType getIncludeType()

Specified by:

getIncludeType in class CxxHeaders

getRoot

public abstract SourcePath getRoot()

Specified by:

getRoot in class CxxHeaders

Returns:

the root of the includes.

getIncludeRoot

public abstract Either<PathSourcePath,SourcePath> getIncludeRoot()

Returns:

the path to add to the preprocessor search path to find the includes. This defaults to the root, but can be overridden to use an alternate path.

getResolvedIncludeRoot

public Optional<Path> getResolvedIncludeRoot(SourcePathResolverAdapter resolver)

Overrides:

getResolvedIncludeRoot in class CxxHeaders

Returns:

the path to add to the preprocessor search path to find the includes. This defaults to the root, but can be overridden to use an alternate path.

getHeaderMap

public abstract Optional<SourcePath> getHeaderMap()

Specified by:

getHeaderMap in class CxxHeaders

Returns:

the path to the optional header map to use for this header pack.

getNameToPathMap

@Value.Auxiliary
public abstract com.google.common.collect.ImmutableSortedMap<Path,SourcePath> getNameToPathMap()

addToHeaderPathNormalizer

public void addToHeaderPathNormalizer(com.facebook.buck.cxx.HeaderPathNormalizer.Builder builder)

Description copied from class: CxxHeaders

Add this header pack to the given HeaderPathNormalizer.Builder.

Specified by:

addToHeaderPathNormalizer in class CxxHeaders

getSymlinkTreeClass

public abstract String getSymlinkTreeClass()

getDeps

public java.util.stream.Stream<BuildRule> getDeps(SourcePathRuleFinder ruleFinder)

Specified by:

getDeps in interface HasCustomDepsLogic

Overrides:

getDeps in class CxxHeaders

Returns:

all deps required by this header pack.

appendToRuleKey

public void appendToRuleKey(RuleKeyAppendable.RuleKeyAppendableSink sink)

Description copied from interface: RuleKeyAppendable

Deprecated. Add additional custom things to the rulekey builder.

Specified by:

appendToRuleKey in interface RuleKeyAppendable

from

public static CxxSymlinkTreeHeaders from(HeaderSymlinkTree symlinkTree,
                                         CxxPreprocessables.IncludeType includeType)

Returns:

a CxxHeaders constructed from the given HeaderSymlinkTree.

of

public static CxxSymlinkTreeHeaders of(CxxPreprocessables.IncludeType includeType,
                                       SourcePath root,
                                       Either<PathSourcePath,SourcePath> includeRoot,
                                       Optional<? extends SourcePath> headerMap,
                                       com.google.common.collect.ImmutableSortedMap<Path,SourcePath> nameToPathMap,
                                       String symlinkTreeClass)