com.facebook.buck.cxx.toolchain

Interface CxxPlatform

All Superinterfaces:

FlavorConvertible

public interface CxxPlatform
extends FlavorConvertible

Interface describing a C/C++ toolchain and platform to build for.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CxxPlatform.Builder

Method Summary

Modifier and Type	Method and Description
static CxxPlatform.Builder	builder()
ArchiverProvider	getAr()
ArchiveContents	getArchiveContents()
com.google.common.collect.ImmutableList<Arg>	getArflags()
CompilerProvider	getAs()
com.google.common.collect.ImmutableList<Arg>	getAsflags()
Optional<CompilerProvider>	getAsm()
com.google.common.collect.ImmutableList<Arg>	getAsmflags()
Optional<PreprocessorProvider>	getAsmpp()
com.google.common.collect.ImmutableList<Arg>	getAsmppflags()
PreprocessorProvider	getAspp()
com.google.common.collect.ImmutableList<Arg>	getAsppflags()
Optional<String>	getBinaryExtension()
CompilerProvider	getCc()
com.google.common.collect.ImmutableList<Arg>	getCflags()
DebugPathSanitizer	getCompilerDebugPathSanitizer()
default com.google.common.collect.ImmutableSortedSet<String>	getConflictingHeaderBasenameWhitelist()
PreprocessorProvider	getCpp()
com.google.common.collect.ImmutableList<Arg>	getCppflags()
Optional<CompilerProvider>	getCuda()
com.google.common.collect.ImmutableList<Arg>	getCudaflags()
Optional<PreprocessorProvider>	getCudapp()
com.google.common.collect.ImmutableList<Arg>	getCudappflags()
CompilerProvider	getCxx()
com.google.common.collect.ImmutableList<Arg>	getCxxflags()
PreprocessorProvider	getCxxpp()
com.google.common.collect.ImmutableList<Arg>	getCxxppflags()
default boolean	getFilepathLengthLimited()
com.google.common.collect.ImmutableMap<String,String>	getFlagMacros()
Flavor	getFlavor()
Optional<HeaderMode>	getHeaderMode()
HeaderVerification	getHeaderVerification()
Optional<CompilerProvider>	getHip()
com.google.common.collect.ImmutableList<Arg>	getHipflags()
Optional<PreprocessorProvider>	getHippp()
com.google.common.collect.ImmutableList<Arg>	getHipppflags()
LinkerProvider	getLd()
com.google.common.collect.ImmutableList<Arg>	getLdflags()
String	getObjectFileExtension()
default PicType	getPicTypeForSharedLinking() nix platforms use PIC object files for shared libraries, while windows doesn't.
boolean	getPrivateHeadersSymlinksEnabled() When building or creating a project, create symlinks for the public headers if it's true.
boolean	getPublicHeadersSymlinksEnabled() When building or creating a project, create symlinks for the public headers if it's true.
Optional<ToolProvider>	getRanlib()
com.google.common.collect.ImmutableList<Arg>	getRanlibflags()
com.google.common.collect.ImmutableMultimap<Linker.LinkableDepType,Arg>	getRuntimeLdflags()
String	getSharedLibraryExtension()
Optional<SharedLibraryInterfaceParams>	getSharedLibraryInterfaceParams()
String	getSharedLibraryVersionedExtensionFormat()
String	getStaticLibraryExtension()
Tool	getStrip()
com.google.common.collect.ImmutableList<Arg>	getStripFlags()
SymbolNameTool	getSymbolNameTool()
Optional<Boolean>	getUseArgFile()
default CxxPlatform	withArchiveContents(ArchiveContents archiveContents)
default CxxPlatform	withAsflags(com.google.common.collect.ImmutableList<Arg> asFlags)
default CxxPlatform	withCflags(com.google.common.collect.ImmutableList<Arg> cFlags)
default CxxPlatform	withCompilerDebugPathSanitizer(DebugPathSanitizer compilerDebugPathSanitizer)
default CxxPlatform	withConflictingHeaderBasenameWhitelist(com.google.common.collect.ImmutableSortedSet<String> conflictingHeaderBasenameWhitelist)
default CxxPlatform	withCpp(PreprocessorProvider cpp)
default CxxPlatform	withCppflags(com.google.common.collect.ImmutableList<Arg> cppFlags)
default CxxPlatform	withCxx(CompilerProvider compilerProvider)
default CxxPlatform	withCxxflags(com.google.common.collect.ImmutableList<Arg> cxxFlags)
default CxxPlatform	withCxxpp(PreprocessorProvider preprocessorProvider)
default CxxPlatform	withCxxppflags(com.google.common.collect.ImmutableList<Arg> cxxppflags)
default CxxPlatform	withFlagMacros(com.google.common.collect.ImmutableMap<String,String> flagMacros)
default CxxPlatform	withFlavor(Flavor flavor)

Method Detail

getFlavor

Flavor getFlavor()

Specified by:

getFlavor in interface FlavorConvertible

getAs

CompilerProvider getAs()

getAsflags

com.google.common.collect.ImmutableList<Arg> getAsflags()

getAspp

PreprocessorProvider getAspp()

getAsppflags

com.google.common.collect.ImmutableList<Arg> getAsppflags()

getCc

CompilerProvider getCc()

getCflags

com.google.common.collect.ImmutableList<Arg> getCflags()

getCxx

CompilerProvider getCxx()

getCxxflags

com.google.common.collect.ImmutableList<Arg> getCxxflags()

getCpp

PreprocessorProvider getCpp()

getCppflags

com.google.common.collect.ImmutableList<Arg> getCppflags()

getCxxpp

PreprocessorProvider getCxxpp()

getCxxppflags

com.google.common.collect.ImmutableList<Arg> getCxxppflags()

getCudapp

Optional<PreprocessorProvider> getCudapp()

getCudappflags

com.google.common.collect.ImmutableList<Arg> getCudappflags()

getCuda

Optional<CompilerProvider> getCuda()

getCudaflags

com.google.common.collect.ImmutableList<Arg> getCudaflags()

getHippp

Optional<PreprocessorProvider> getHippp()

getHipppflags

com.google.common.collect.ImmutableList<Arg> getHipppflags()

getHip

Optional<CompilerProvider> getHip()

getHipflags

com.google.common.collect.ImmutableList<Arg> getHipflags()

getAsmpp

Optional<PreprocessorProvider> getAsmpp()

getAsmppflags

com.google.common.collect.ImmutableList<Arg> getAsmppflags()

getAsm

Optional<CompilerProvider> getAsm()

getAsmflags

com.google.common.collect.ImmutableList<Arg> getAsmflags()

getLd

LinkerProvider getLd()

getLdflags

com.google.common.collect.ImmutableList<Arg> getLdflags()

getRuntimeLdflags

com.google.common.collect.ImmutableMultimap<Linker.LinkableDepType,Arg> getRuntimeLdflags()

getStrip

Tool getStrip()

getStripFlags

com.google.common.collect.ImmutableList<Arg> getStripFlags()

getAr

ArchiverProvider getAr()

getArchiveContents

ArchiveContents getArchiveContents()

getArflags

com.google.common.collect.ImmutableList<Arg> getArflags()

getRanlib

Optional<ToolProvider> getRanlib()

getRanlibflags

com.google.common.collect.ImmutableList<Arg> getRanlibflags()

getSymbolNameTool

SymbolNameTool getSymbolNameTool()

getSharedLibraryExtension

String getSharedLibraryExtension()

getSharedLibraryVersionedExtensionFormat

String getSharedLibraryVersionedExtensionFormat()

getStaticLibraryExtension

String getStaticLibraryExtension()

getObjectFileExtension

String getObjectFileExtension()

getCompilerDebugPathSanitizer

DebugPathSanitizer getCompilerDebugPathSanitizer()

getHeaderVerification

HeaderVerification getHeaderVerification()

getUseArgFile

Optional<Boolean> getUseArgFile()

getFlagMacros

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

Returns:

a map for macro names to their respective expansions, to be used to expand macro references in user-provided flags.

getSharedLibraryInterfaceParams

Optional<SharedLibraryInterfaceParams> getSharedLibraryInterfaceParams()

Returns:

params used to determine which shared library interfaces to generate, which are used for linking in liu of the original shared library.

getBinaryExtension

Optional<String> getBinaryExtension()

getPublicHeadersSymlinksEnabled

boolean getPublicHeadersSymlinksEnabled()

When building or creating a project, create symlinks for the public headers if it's true. It would allow public headers to include an other public header with #include "foobar.h"\ even if it's not in the same folder.

getPrivateHeadersSymlinksEnabled

boolean getPrivateHeadersSymlinksEnabled()

When building or creating a project, create symlinks for the public headers if it's true.

getPicTypeForSharedLinking

@Value.Default
default PicType getPicTypeForSharedLinking()

nix platforms use PIC object files for shared libraries, while windows doesn't.

getConflictingHeaderBasenameWhitelist

@Value.Default
default com.google.common.collect.ImmutableSortedSet<String> getConflictingHeaderBasenameWhitelist()

Returns:

whitelist of basenames to exclude from conflicting header checks.

getHeaderMode

Optional<HeaderMode> getHeaderMode()

Returns:

the explicit header mode to use for this platform.

getFilepathLengthLimited

@Value.Default
default boolean getFilepathLengthLimited()

Returns:

whether shorter names for intermediate files should be used

builder

static CxxPlatform.Builder builder()

withFlavor

default CxxPlatform withFlavor(Flavor flavor)

withAsflags

default CxxPlatform withAsflags(com.google.common.collect.ImmutableList<Arg> asFlags)

withCppflags

default CxxPlatform withCppflags(com.google.common.collect.ImmutableList<Arg> cppFlags)

withCflags

default CxxPlatform withCflags(com.google.common.collect.ImmutableList<Arg> cFlags)

withCpp

default CxxPlatform withCpp(PreprocessorProvider cpp)

withConflictingHeaderBasenameWhitelist

default CxxPlatform withConflictingHeaderBasenameWhitelist(com.google.common.collect.ImmutableSortedSet<String> conflictingHeaderBasenameWhitelist)

withCxxppflags

default CxxPlatform withCxxppflags(com.google.common.collect.ImmutableList<Arg> cxxppflags)

withCxxflags

default CxxPlatform withCxxflags(com.google.common.collect.ImmutableList<Arg> cxxFlags)

withArchiveContents

default CxxPlatform withArchiveContents(ArchiveContents archiveContents)

withFlagMacros

default CxxPlatform withFlagMacros(com.google.common.collect.ImmutableMap<String,String> flagMacros)

withCompilerDebugPathSanitizer

default CxxPlatform withCompilerDebugPathSanitizer(DebugPathSanitizer compilerDebugPathSanitizer)

withCxxpp

default CxxPlatform withCxxpp(PreprocessorProvider preprocessorProvider)

withCxx

default CxxPlatform withCxx(CompilerProvider compilerProvider)