com.facebook.buck.cxx.config

Class CxxBuckConfig

java.lang.Object

com.facebook.buck.cxx.config.CxxBuckConfig

public class CxxBuckConfig
extends Object

Contains platform independent settings for C/C++ rules.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FLAVOR_LIBRARY_TYPE
static String	DEFAULT_FLAVOR_PLATFORM

Constructor Summary

Constructors

Constructor and Description
CxxBuckConfig(BuckConfig delegate)
CxxBuckConfig(BuckConfig delegate, Flavor flavor)

Method Summary

Modifier and Type	Method and Description
boolean	checkGTestTestList()
Optional<ArchiveContents>	getArchiveContents()
Optional<ArchiverProvider>	getArchiverProvider(Platform defaultPlatform)
Optional<com.google.common.collect.ImmutableList<String>>	getArflags()
Optional<CompilerProvider>	getAs()
Optional<com.google.common.collect.ImmutableList<String>>	getAsflags()
Optional<CompilerProvider>	getAsm()
Optional<com.google.common.collect.ImmutableList<String>>	getAsmflags()
Optional<PreprocessorProvider>	getAsmpp()
Optional<com.google.common.collect.ImmutableList<String>>	getAsmppflags()
Optional<PreprocessorProvider>	getAspp()
Optional<com.google.common.collect.ImmutableList<String>>	getAsppflags()
Optional<String>	getBinaryExtension()
Optional<BuildTarget>	getBoostTestDep(TargetConfiguration targetConfiguration)
Optional<CompilerProvider>	getCc()
Optional<com.google.common.collect.ImmutableList<String>>	getCflags()
com.google.common.collect.ImmutableSortedSet<String>	getConflictingHeaderBasenameWhitelist()
Optional<PreprocessorProvider>	getCpp()
Optional<com.google.common.collect.ImmutableList<String>>	getCppflags()
Optional<CompilerProvider>	getCuda()
Optional<com.google.common.collect.ImmutableList<String>>	getCudaflags()
Optional<PreprocessorProvider>	getCudapp()
Optional<com.google.common.collect.ImmutableList<String>>	getCudappflags()
Optional<CompilerProvider>	getCxx()
Optional<com.google.common.collect.ImmutableList<String>>	getCxxflags()
static com.google.common.collect.ImmutableSet<Flavor>	getCxxFlavors(BuckConfig config) Constructs set of flavors given in a .buckconfig file, as is specified by section names of the form cxx#{flavor name}.
Optional<PreprocessorProvider>	getCxxpp()
Optional<com.google.common.collect.ImmutableList<String>>	getCxxppflags()
int	getDebugPathSanitizerLimit()
com.google.common.collect.ImmutableSet<Flavor>	getDeclaredPlatforms()
com.google.common.collect.ImmutableMap<String,Flavor>	getDefaultFlavorsForRuleType(RuleType type)
Optional<String>	getDefaultPlatform()
boolean	getDefaultReexportAllHeaderDependencies()
BuckConfig	getDelegate()
com.google.common.collect.ImmutableMap<String,String>	getEnvironment()
Boolean	getFilepathLengthLimited()
com.google.common.collect.ImmutableMap<Flavor,CxxBuckConfig>	getFlavoredConfigs()
Optional<BuildTarget>	getGtestDefaultTestMainDep(TargetConfiguration targetConfiguration)
Optional<BuildTarget>	getGtestDep(TargetConfiguration targetConfiguration)
Optional<HeaderMode>	getHeaderMode()
HeaderVerification	getHeaderVerificationOrIgnore()
Optional<CompilerProvider>	getHip()
Optional<com.google.common.collect.ImmutableList<String>>	getHipflags()
Optional<PreprocessorProvider>	getHippp()
Optional<com.google.common.collect.ImmutableList<String>>	getHipppflags()
Optional<String>	getHostPlatform()
Optional<com.google.common.collect.ImmutableList<String>>	getIndependentShlibInterfacesLdflags()
Optional<com.google.common.collect.ImmutableList<String>>	getLdflags()
Optional<LinkerProvider>	getLinkerProvider(LinkerProvider.Type defaultType) Construct a linker based on `ld` and `linker_platform` sections in the config.
boolean	getLinkGroupsEnabled()
Optional<Boolean>	getLinkGroupsEnabledSetting()
Optional<RuleScheduleInfo>	getLinkScheduleInfo()
long	getMaximumTestOutputSize()
Optional<ToolProvider>	getNm()
Optional<ToolProvider>	getObjcopy()
Optional<String>	getObjectFileExtension()
Optional<Path>	getPath(String name)
boolean	getPrivateHeadersSymlinksEnabled()
Optional<Boolean>	getPrivateHeadersSymlinksSetting()
static Optional<UnresolvedCxxPlatform>	getProviderBasedPlatform(BuckConfig config, Flavor flavor) If the config specifies a value for "toolchain_target", returns a UnresolvedCxxPlatform backed by the specified target.
boolean	getPublicHeadersSymlinksEnabled()
Optional<Boolean>	getPublicHeadersSymlinksSetting()
Optional<ToolProvider>	getRanlib()
Optional<com.google.common.collect.ImmutableList<String>>	getRanlibflags()
Optional<String>	getSharedLibraryExtension()
Optional<SharedLibraryInterfaceParams.Type>	getSharedLibraryInterfaces()
boolean	getShouldRemapHostPlatform()
PathSourcePath	getSourcePath(Path path)
Optional<SourcePath>	getSourcePath(String name, TargetConfiguration targetConfiguration)
Optional<String>	getStaticLibraryExtension()
Optional<Tool>	getStrip()
Optional<Boolean>	getUseArgFile()
Boolean	getUseDetailedUntrackedHeaderMessages()
boolean	isIndependentSharedLibraryInterfaces()
boolean	isPCHEnabled()
boolean	isUniqueLibraryNameEnabled()
boolean	shouldCacheBinaries()
boolean	shouldCacheLinks()
boolean	shouldCacheStrip()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FLAVOR_LIBRARY_TYPE

public static final String DEFAULT_FLAVOR_LIBRARY_TYPE

See Also:

Constant Field Values

DEFAULT_FLAVOR_PLATFORM

public static final String DEFAULT_FLAVOR_PLATFORM

See Also:

Constant Field Values

Constructor Detail

CxxBuckConfig

public CxxBuckConfig(BuckConfig delegate)

CxxBuckConfig

public CxxBuckConfig(BuckConfig delegate,
                     Flavor flavor)

Method Detail

getCxxFlavors

public static com.google.common.collect.ImmutableSet<Flavor> getCxxFlavors(BuckConfig config)

Constructs set of flavors given in a .buckconfig file, as is specified by section names of the form cxx#{flavor name}.

getFlavoredConfigs

public com.google.common.collect.ImmutableMap<Flavor,CxxBuckConfig> getFlavoredConfigs()

getEnvironment

public com.google.common.collect.ImmutableMap<String,String> getEnvironment()

Returns:

the environment in which BuckConfig was created.

getGtestDep

public Optional<BuildTarget> getGtestDep(TargetConfiguration targetConfiguration)

Returns:

the BuildTarget which represents the gtest library.

getGtestDefaultTestMainDep

public Optional<BuildTarget> getGtestDefaultTestMainDep(TargetConfiguration targetConfiguration)

Returns:

the BuildTarget which represents the main function that gtest tests should use by default (if no other main is given).

getBoostTestDep

public Optional<BuildTarget> getBoostTestDep(TargetConfiguration targetConfiguration)

Returns:

the BuildTarget which represents the boost testing library.

getPath

public Optional<Path> getPath(String name)

getSourcePath

@Nullable
public PathSourcePath getSourcePath(Path path)

getSourcePath

public Optional<SourcePath> getSourcePath(String name,
                                          TargetConfiguration targetConfiguration)

getDefaultPlatform

public Optional<String> getDefaultPlatform()

getHostPlatform

public Optional<String> getHostPlatform()

getAsflags

public Optional<com.google.common.collect.ImmutableList<String>> getAsflags()

getAsppflags

public Optional<com.google.common.collect.ImmutableList<String>> getAsppflags()

getCflags

public Optional<com.google.common.collect.ImmutableList<String>> getCflags()

getCxxflags

public Optional<com.google.common.collect.ImmutableList<String>> getCxxflags()

getCppflags

public Optional<com.google.common.collect.ImmutableList<String>> getCppflags()

getCxxppflags

public Optional<com.google.common.collect.ImmutableList<String>> getCxxppflags()

getCudaflags

public Optional<com.google.common.collect.ImmutableList<String>> getCudaflags()

getCudappflags

public Optional<com.google.common.collect.ImmutableList<String>> getCudappflags()

getHipflags

public Optional<com.google.common.collect.ImmutableList<String>> getHipflags()

getHipppflags

public Optional<com.google.common.collect.ImmutableList<String>> getHipppflags()

getAsmflags

public Optional<com.google.common.collect.ImmutableList<String>> getAsmflags()

getAsmppflags

public Optional<com.google.common.collect.ImmutableList<String>> getAsmppflags()

getLdflags

public Optional<com.google.common.collect.ImmutableList<String>> getLdflags()

getArflags

public Optional<com.google.common.collect.ImmutableList<String>> getArflags()

getRanlibflags

public Optional<com.google.common.collect.ImmutableList<String>> getRanlibflags()

getArchiverProvider

public Optional<ArchiverProvider> getArchiverProvider(Platform defaultPlatform)

getMaximumTestOutputSize

public long getMaximumTestOutputSize()

Returns:

the maximum size in bytes of test output to report in test results.

getAs

public Optional<CompilerProvider> getAs()

getAspp

public Optional<PreprocessorProvider> getAspp()

getCc

public Optional<CompilerProvider> getCc()

getCpp

public Optional<PreprocessorProvider> getCpp()

getCxx

public Optional<CompilerProvider> getCxx()

getCxxpp

public Optional<PreprocessorProvider> getCxxpp()

getCuda

public Optional<CompilerProvider> getCuda()

getCudapp

public Optional<PreprocessorProvider> getCudapp()

getHip

public Optional<CompilerProvider> getHip()

getHippp

public Optional<PreprocessorProvider> getHippp()

getAsm

public Optional<CompilerProvider> getAsm()

getAsmpp

public Optional<PreprocessorProvider> getAsmpp()

getUseArgFile

public Optional<Boolean> getUseArgFile()

getLinkerProvider

public Optional<LinkerProvider> getLinkerProvider(LinkerProvider.Type defaultType)

Construct a linker based on `ld` and `linker_platform` sections in the config.

Parameters:

defaultType - the default type for a linker if `linker_platform` is not specified in the config.

getHeaderVerificationOrIgnore

public HeaderVerification getHeaderVerificationOrIgnore()

getLinkGroupsEnabledSetting

public Optional<Boolean> getLinkGroupsEnabledSetting()

getLinkGroupsEnabled

public boolean getLinkGroupsEnabled()

getPublicHeadersSymlinksSetting

public Optional<Boolean> getPublicHeadersSymlinksSetting()

getPublicHeadersSymlinksEnabled

public boolean getPublicHeadersSymlinksEnabled()

getPrivateHeadersSymlinksSetting

public Optional<Boolean> getPrivateHeadersSymlinksSetting()

getPrivateHeadersSymlinksEnabled

public boolean getPrivateHeadersSymlinksEnabled()

getLinkScheduleInfo

public Optional<RuleScheduleInfo> getLinkScheduleInfo()

shouldCacheLinks

public boolean shouldCacheLinks()

shouldCacheStrip

public boolean shouldCacheStrip()

shouldCacheBinaries

public boolean shouldCacheBinaries()

checkGTestTestList

public boolean checkGTestTestList()

isPCHEnabled

public boolean isPCHEnabled()

getArchiveContents

public Optional<ArchiveContents> getArchiveContents()

getDefaultFlavorsForRuleType

public com.google.common.collect.ImmutableMap<String,Flavor> getDefaultFlavorsForRuleType(RuleType type)

getDebugPathSanitizerLimit

public int getDebugPathSanitizerLimit()

getShouldRemapHostPlatform

public boolean getShouldRemapHostPlatform()

Returns:

whether to remap to the underlying host platform or to use #default

getRanlib

public Optional<ToolProvider> getRanlib()

getObjcopy

public Optional<ToolProvider> getObjcopy()

getNm

public Optional<ToolProvider> getNm()

getStrip

public Optional<Tool> getStrip()

isUniqueLibraryNameEnabled

public boolean isUniqueLibraryNameEnabled()

getDefaultReexportAllHeaderDependencies

public boolean getDefaultReexportAllHeaderDependencies()

getSharedLibraryInterfaces

public Optional<SharedLibraryInterfaceParams.Type> getSharedLibraryInterfaces()

Returns:

whether to enable shared library interfaces.

getIndependentShlibInterfacesLdflags

public Optional<com.google.common.collect.ImmutableList<String>> getIndependentShlibInterfacesLdflags()

Returns:

additional flags to pass to the linker when linking independent shared library interfaces.

isIndependentSharedLibraryInterfaces

public boolean isIndependentSharedLibraryInterfaces()

Returns:

whether to generate a rule's shared library interface directly from it's object files, to avoid having to wait for it's shared library to build.

getDeclaredPlatforms

public com.google.common.collect.ImmutableSet<Flavor> getDeclaredPlatforms()

Returns:

the list of flavors that buck will consider valid when building the target graph.

getBinaryExtension

public Optional<String> getBinaryExtension()

Returns:

the extension to use for binaries (e.g. ".exe").

getSharedLibraryExtension

public Optional<String> getSharedLibraryExtension()

Returns:

the extension to use for shared libraries (e.g. ".so").

getStaticLibraryExtension

public Optional<String> getStaticLibraryExtension()

Returns:

the extension to use for static libraries (e.g. ".a").

getObjectFileExtension

public Optional<String> getObjectFileExtension()

Returns:

the extension to use for object files (e.g. ".o").

getConflictingHeaderBasenameWhitelist

public com.google.common.collect.ImmutableSortedSet<String> getConflictingHeaderBasenameWhitelist()

getHeaderMode

public Optional<HeaderMode> getHeaderMode()

Returns:

the configured C/C++ header mode.

getUseDetailedUntrackedHeaderMessages

public Boolean getUseDetailedUntrackedHeaderMessages()

Returns:

whether to generate more detailed untracked header messages.

getFilepathLengthLimited

public Boolean getFilepathLengthLimited()

Returns:

whether short names for intermediate files should be used

getDelegate

public BuckConfig getDelegate()

getProviderBasedPlatform

public static Optional<UnresolvedCxxPlatform> getProviderBasedPlatform(BuckConfig config,
                                                                       Flavor flavor)

If the config specifies a value for "toolchain_target", returns a UnresolvedCxxPlatform backed by the specified target.