com.facebook.buck.cxx.toolchain

Class HeaderVerification

java.lang.Object

com.facebook.buck.cxx.toolchain.HeaderVerification

All Implemented Interfaces:

AddsToRuleKey

public abstract class HeaderVerification
extends Object
implements AddsToRuleKey

Defines how to handle headers that get included during the build but aren't explicitly tracked in any build files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeaderVerification.Mode

Constructor Summary

Constructors

Constructor and Description
HeaderVerification()

Method Summary

Modifier and Type	Method and Description
abstract HeaderVerification.Mode	getMode()
abstract com.google.common.collect.ImmutableSortedSet<String>	getPlatformWhitelist()
abstract com.google.common.collect.ImmutableSortedSet<String>	getWhitelist()
protected com.google.common.collect.ImmutableList<FasterPattern>	getWhitelistPatterns()
boolean	isWhitelisted(String header)
static HeaderVerification	of(HeaderVerification.Mode mode)
static HeaderVerification	of(HeaderVerification.Mode mode, com.google.common.collect.ImmutableSortedSet<String> whitelist, com.google.common.collect.ImmutableSortedSet<String> platformWhitelist)
HeaderVerification	withPlatformWhitelist(Iterable<String> elements)

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderVerification

public HeaderVerification()

Method Detail

getMode

public abstract HeaderVerification.Mode getMode()

getWhitelist

@Value.NaturalOrder
public abstract com.google.common.collect.ImmutableSortedSet<String> getWhitelist()

Returns:

a list of regexes which match headers which should be exempt from verification.

getPlatformWhitelist

@Value.NaturalOrder
public abstract com.google.common.collect.ImmutableSortedSet<String> getPlatformWhitelist()

Returns:

a list of regexes which match headers from the platform SDK. The path for the platforms might depend on the disk layout. Therefore, we don't want that one to be included in the rule keys.

getWhitelistPatterns

@Value.Derived
protected com.google.common.collect.ImmutableList<FasterPattern> getWhitelistPatterns()

of

public static HeaderVerification of(HeaderVerification.Mode mode)

of

public static HeaderVerification of(HeaderVerification.Mode mode,
                                    com.google.common.collect.ImmutableSortedSet<String> whitelist,
                                    com.google.common.collect.ImmutableSortedSet<String> platformWhitelist)

isWhitelisted

public boolean isWhitelisted(String header)

Returns:

whether the given header has been whitelisted.

withPlatformWhitelist

public HeaderVerification withPlatformWhitelist(Iterable<String> elements)