com.facebook.buck.cxx

Class CxxHeaders

java.lang.Object

com.facebook.buck.cxx.CxxHeaders

All Implemented Interfaces:

AddsToRuleKey, HasCustomDepsLogic

Direct Known Subclasses:

CxxHeadersDir, CxxRawHeaders, CxxSymlinkTreeHeaders

public abstract class CxxHeaders
extends Object
implements AddsToRuleKey, HasCustomDepsLogic

Encapsulates headers from a single root location.

Constructor Summary

Constructors

Constructor and Description
CxxHeaders()

Method Summary

Modifier and Type	Method and Description
abstract void	addToHeaderPathNormalizer(com.facebook.buck.cxx.HeaderPathNormalizer.Builder builder) Add this header pack to the given HeaderPathNormalizer.Builder.
static Iterable<String>	getArgs(Iterable<CxxHeaders> cxxHeaderses, SourcePathResolverAdapter resolver, Optional<PathShortener> pathMinimizer, Preprocessor preprocessor)
java.util.stream.Stream<BuildRule>	getDeps(SourcePathRuleFinder ruleFinder)
abstract Optional<SourcePath>	getHeaderMap()
abstract CxxPreprocessables.IncludeType	getIncludeType()
Optional<Path>	getResolvedIncludeRoot(SourcePathResolverAdapter resolver)
abstract SourcePath	getRoot()

Methods inherited from class java.lang.Object

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

Constructor Detail

CxxHeaders

public CxxHeaders()

Method Detail

getIncludeType

public abstract CxxPreprocessables.IncludeType getIncludeType()

getRoot

@Nullable
public abstract SourcePath getRoot()

Returns:

the root of the includes.

getHeaderMap

public abstract Optional<SourcePath> getHeaderMap()

Returns:

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

addToHeaderPathNormalizer

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

Add this header pack to the given HeaderPathNormalizer.Builder.

getDeps

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

Specified by:

getDeps in interface HasCustomDepsLogic

Returns:

all deps required by this header pack.

getResolvedIncludeRoot

public Optional<Path> getResolvedIncludeRoot(SourcePathResolverAdapter resolver)

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.

getArgs

public static Iterable<String> getArgs(Iterable<CxxHeaders> cxxHeaderses,
                                       SourcePathResolverAdapter resolver,
                                       Optional<PathShortener> pathMinimizer,
                                       Preprocessor preprocessor)

Returns:

the arguments to add to the preprocessor command line to include the given header packs in preprocessor search path.