Package com.facebook.buck.apple
Class AppleTestDescriptionArg
- java.lang.Object
-
- com.facebook.buck.apple.AppleTestDescriptionArg
-
- All Implemented Interfaces:
AppleNativeTargetDescriptionArg
,HasAppleBundleFields
,HasAppleCodesignFields
,HasEntitlementsFile
,BuildRuleArg
,ConstructorArg
,DataTransferObject
,HasContacts
,HasDeclaredDeps
,HasDefaultPlatform
,HasTests
,HasTestTimeout
,HasDefaultFlavors
,HasTestRunner
,CxxConstructorArg
,CxxLibraryDescription.CommonArg
,LinkableCxxConstructorArg
,HasSystemFrameworkAndLibraries
,SwiftCommonArg
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class AppleTestDescriptionArg extends Object
Immutable implementation ofAppleTestDescription.AbstractAppleTestDescriptionArg
.Use the builder to create immutable instances:
AppleTestDescriptionArg.builder()
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AppleTestDescriptionArg.Builder
Builds instances of typeAppleTestDescriptionArg
.
-
Field Summary
-
Fields inherited from interface com.facebook.buck.core.description.arg.BuildRuleArg
DEFAULT_TARGET_PLATFORM_PARAM_NAME
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Default Methods Modifier and Type Method Description static AppleTestDescriptionArg.Builder
builder()
Creates a builder forAppleTestDescriptionArg
.boolean
equals(Object another)
This instance is equal to all instances ofAppleTestDescriptionArg
that have equal attribute values.AppleAssetCatalogsCompilationOptions
getAssetCatalogsCompilationOptions()
Optional<SourcePath>
getBridgingHeader()
These fields are passed through to SwiftLibrary for mixed C/Swift targets; they are not used otherwise.Optional<Boolean>
getCanBeAsset()
com.google.common.collect.ImmutableList<String>
getCodesignFlags()
Optional<String>
getCodesignIdentity()
com.google.common.collect.ImmutableList<UnconfiguredBuildTarget>
getCompatibleWith()
A list ofconfig_setting
a target is compatible with.com.google.common.collect.ImmutableList<StringWithMacros>
getCompilerFlags()
com.google.common.collect.ImmutableSortedMap<String,com.google.common.collect.ImmutableMap<String,String>>
getConfigs()
com.google.common.collect.ImmutableSortedSet<String>
getContacts()
CxxDeps
getCxxDeps()
Override parent class's deps to include exported deps.Optional<Linker.CxxRuntimeType>
getCxxRuntimeType()
com.google.common.collect.ImmutableSortedSet<Flavor>
getDefaultFlavors()
Optional<Flavor>
getDefaultPlatform()
com.google.common.collect.ImmutableMap<String,Flavor>
getDefaults()
Optional<UnconfiguredBuildTarget>
getDefaultTargetPlatform()
The name of build target default "new" platform: it is used when a platform is not specified either globally or in a target which used this target as a dependency.com.google.common.collect.ImmutableSortedSet<BuildTarget>
getDeps()
com.google.common.collect.ImmutableMap<String,String>
getDestinationSpecifier()
Optional<SourcePath>
getEntitlementsFile()
Optional<com.google.common.collect.ImmutableMap<String,String>>
getEnv()
Optional<String>
getExecutableName()
CxxDeps
getExportedCxxDeps()
com.google.common.collect.ImmutableSortedSet<BuildTarget>
getExportedDeps()
SourceSortedSet
getExportedHeaders()
CxxPreprocessables.IncludeType
getExportedHeaderStyle()
com.google.common.collect.ImmutableMap<CxxSource.Type,PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>>
getExportedLangPlatformPreprocessorFlags()
com.google.common.collect.ImmutableMap<CxxSource.Type,com.google.common.collect.ImmutableList<StringWithMacros>>
getExportedLangPreprocessorFlags()
com.google.common.collect.ImmutableList<StringWithMacros>
getExportedLinkerFlags()
PatternMatchedCollection<com.google.common.collect.ImmutableSortedSet<BuildTarget>>
getExportedPlatformDeps()
PatternMatchedCollection<SourceSortedSet>
getExportedPlatformHeaders()
PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>
getExportedPlatformLinkerFlags()
PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>
getExportedPlatformPreprocessorFlags()
com.google.common.collect.ImmutableList<StringWithMacros>
getExportedPostLinkerFlags()
PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>
getExportedPostPlatformLinkerFlags()
com.google.common.collect.ImmutableList<StringWithMacros>
getExportedPreprocessorFlags()
default Either<AppleBundleExtension,String>
getExtension()
com.google.common.collect.ImmutableList<SourcePath>
getExtraXcodeFiles()
extra_xcode_sources will add the files to the list of files in the project and won't add them to an Xcode target.com.google.common.collect.ImmutableList<SourcePath>
getExtraXcodeSources()
extra_xcode_sources will add the files to the list of files to be compiled in the Xcode target.boolean
getFatLto()
Optional<Boolean>
getForceStatic()
com.google.common.collect.ImmutableSortedSet<FrameworkPath>
getFrameworks()
Optional<String>
getHeaderNamespace()
Optional<String>
getHeaderPathPrefix()
SourceSortedSet
getHeaders()
com.google.common.collect.ImmutableSortedSet<String>
getIncludeDirectories()
A list of include directories to be added to the compile command for compiling this cxx target.SourcePath
getInfoPlist()
com.google.common.collect.ImmutableMap<String,String>
getInfoPlistSubstitutions()
Optional<Boolean>
getIsAppClip()
boolean
getIsUiTest()
com.google.common.collect.ImmutableSortedSet<String>
getLabels()
com.google.common.collect.ImmutableMap<CxxSource.Type,com.google.common.collect.ImmutableList<StringWithMacros>>
getLangCompilerFlags()
com.google.common.collect.ImmutableMap<CxxSource.Type,PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>>
getLangPlatformCompilerFlags()
com.google.common.collect.ImmutableMap<CxxSource.Type,PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>>
getLangPlatformPreprocessorFlags()
com.google.common.collect.ImmutableMap<CxxSource.Type,com.google.common.collect.ImmutableList<StringWithMacros>>
getLangPreprocessorFlags()
com.google.common.collect.ImmutableSortedSet<FrameworkPath>
getLibraries()
com.google.common.collect.ImmutableSet<SourcePath>
getLicenses()
com.google.common.collect.ImmutableList<String>
getLinkerExtraOutputs()
com.google.common.collect.ImmutableList<StringWithMacros>
getLinkerFlags()
Optional<String>
getLinkGroup()
Defines the link group.Optional<com.google.common.collect.ImmutableList<CxxLinkGroupMapping>>
getLinkGroupMap()
Defines the list of link group mappings.Optional<Linker.LinkableDepType>
getLinkStyle()
Optional<Boolean>
getLinkWhole()
Optional<ModuleMapMode>
getModulemapMode()
A modulemap mode, to override the one specified in .buckconfig.Optional<String>
getModuleName()
String
getName()
Each rule has a namePatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>
getPlatformCompilerFlags()
PatternMatchedCollection<com.google.common.collect.ImmutableSortedSet<BuildTarget>>
getPlatformDeps()
PatternMatchedCollection<SourceSortedSet>
getPlatformHeaders()
PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>
getPlatformLinkerFlags()
PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>
getPlatformPreprocessorFlags()
PatternMatchedCollection<com.google.common.collect.ImmutableSortedSet<SourceWithFlags>>
getPlatformSrcs()
com.google.common.collect.ImmutableList<StringWithMacros>
getPostLinkerFlags()
PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>
getPostPlatformLinkerFlags()
Optional<SourcePath>
getPrecompiledHeader()
Optional<NativeLinkableGroup.Linkage>
getPreferredLinkage()
Optional<SourcePath>
getPrefixHeader()
com.google.common.collect.ImmutableList<StringWithMacros>
getPreprocessorFlags()
CxxDeps
getPrivateCxxDeps()
default Optional<String>
getProductName()
com.google.common.collect.ImmutableSortedSet<String>
getPublicIncludeDirectories()
A list of include directories to be added to the compile command for compiling this cxx target and every target that depends on it.com.google.common.collect.ImmutableSortedSet<String>
getPublicSystemIncludeDirectories()
A list of include directories to be added to the compile command for compiling this cxx target and every target that depends on it.com.google.common.collect.ImmutableSortedSet<SourcePath>
getRawHeaders()
Raw headers are headers which are used as they are (via compilation flags).Optional<BuildTarget>
getRunner()
boolean
getRunTestSeparately()
Optional<Either<SourcePath,String>>
getSnapshotImagesDiffPath()
Optional<Either<SourcePath,String>>
getSnapshotReferenceImagesPath()
Optional<String>
getSoname()
Optional<TestRunnerSpec>
getSpecs()
com.google.common.collect.ImmutableSortedSet<SourceWithFlags>
getSrcs()
Optional<String>
getStaticLibraryBasename()
Optional<Pattern>
getSupportedPlatformsRegex()
Optional<Boolean>
getSupportsMergedLinking()
com.google.common.collect.ImmutableList<StringWithMacros>
getSwiftCompilerFlags()
Optional<String>
getSwiftVersion()
Optional<String>
getTargetSdkVersion()
The minimum OS version for which this target should be built.Optional<BuildTarget>
getTestHostApp()
Optional<Long>
getTestRuleTimeoutMs()
com.google.common.collect.ImmutableSortedSet<BuildTarget>
getTests()
boolean
getThinLto()
Optional<BuildTarget>
getUiTestTargetApp()
Optional<Boolean>
getXcodePrivateHeadersSymlinks()
Optional<String>
getXcodeProductType()
Optional<Boolean>
getXcodePublicHeadersSymlinks()
int
hashCode()
Computes a hash code from attributes:runTestSeparately
,isUiTest
,testHostApp
,uiTestTargetApp
,snapshotReferenceImagesPath
,snapshotImagesDiffPath
,destinationSpecifier
,env
,configs
,headerPathPrefix
,modular
,modulemapMode
,targetSdkVersion
,exportedHeaders
,exportedPlatformHeaders
,exportedPreprocessorFlags
,exportedPlatformPreprocessorFlags
,exportedLangPreprocessorFlags
,exportedLangPlatformPreprocessorFlags
,exportedLinkerFlags
,exportedPostLinkerFlags
,exportedPlatformLinkerFlags
,exportedPostPlatformLinkerFlags
,exportedDeps
,exportedPlatformDeps
,supportedPlatformsRegex
,soname
,staticLibraryBasename
,forceStatic
,linkWhole
,canBeAsset
,preferredLinkage
,xcodePublicHeadersSymlinks
,xcodePrivateHeadersSymlinks
,extraXcodeSources
,extraXcodeFiles
,reexportAllHeaderDependencies
,bridgingHeader
,moduleName
,publicIncludeDirectories
,publicSystemIncludeDirectories
,exportedCxxDeps
,cxxDeps
,exportedHeaderStyle
,supportsMergedLinking
,linkStyle
,linkGroupMap
,linkGroup
,thinLto
,fatLto
,srcs
,platformSrcs
,headers
,rawHeaders
,includeDirectories
,platformHeaders
,prefixHeader
,precompiledHeader
,compilerFlags
,langCompilerFlags
,langPlatformCompilerFlags
,platformCompilerFlags
,preprocessorFlags
,platformPreprocessorFlags
,langPreprocessorFlags
,langPlatformPreprocessorFlags
,linkerFlags
,postLinkerFlags
,linkerExtraOutputs
,platformLinkerFlags
,executableName
,postPlatformLinkerFlags
,platformDeps
,headerNamespace
,cxxRuntimeType
,defaults
,defaultFlavors
,privateCxxDeps
,licenses
,labels
,defaultTargetPlatform
,compatibleWith
,name
,deps
,defaultPlatform
,tests
,frameworks
,libraries
,swiftCompilerFlags
,swiftVersion
,infoPlist
,xcodeProductType
,isAppClip
,infoPlistSubstitutions
,assetCatalogsCompilationOptions
,codesignFlags
,codesignIdentity
,contacts
,entitlementsFile
,testRuleTimeoutMs
,runner
,specs
.boolean
isModular()
Optional<Boolean>
isReexportAllHeaderDependencies()
Controls whether the headers of dependencies in "deps" is re-exported for compiling targets that depend on this one.String
toString()
Prints the immutable valueAppleTestDescriptionArg
with attribute values.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.facebook.buck.apple.AppleNativeTargetDescriptionArg
checkModularUsage
-
Methods inherited from interface com.facebook.buck.core.description.arg.BuildRuleArg
labelsContainsAnyOf
-
Methods inherited from interface com.facebook.buck.cxx.CxxConstructorArg
checkDuplicateSources
-
Methods inherited from interface com.facebook.buck.cxx.CxxLibraryDescription.CommonArg
checkHeadersUsage
-
-
-
-
Method Detail
-
getRunTestSeparately
public boolean getRunTestSeparately()
- Returns:
- The value of the
runTestSeparately
attribute
-
getIsUiTest
public boolean getIsUiTest()
- Returns:
- The value of the
isUiTest
attribute
-
getTestHostApp
public Optional<BuildTarget> getTestHostApp()
- Returns:
- The value of the
testHostApp
attribute
-
getUiTestTargetApp
public Optional<BuildTarget> getUiTestTargetApp()
- Returns:
- The value of the
uiTestTargetApp
attribute
-
getSnapshotReferenceImagesPath
public Optional<Either<SourcePath,String>> getSnapshotReferenceImagesPath()
- Returns:
- The value of the
snapshotReferenceImagesPath
attribute
-
getSnapshotImagesDiffPath
public Optional<Either<SourcePath,String>> getSnapshotImagesDiffPath()
- Returns:
- The value of the
snapshotImagesDiffPath
attribute
-
getDestinationSpecifier
public com.google.common.collect.ImmutableMap<String,String> getDestinationSpecifier()
- Returns:
- The value of the
destinationSpecifier
attribute
-
getEnv
public Optional<com.google.common.collect.ImmutableMap<String,String>> getEnv()
- Returns:
- The value of the
env
attribute
-
getConfigs
public com.google.common.collect.ImmutableSortedMap<String,com.google.common.collect.ImmutableMap<String,String>> getConfigs()
- Specified by:
getConfigs
in interfaceAppleNativeTargetDescriptionArg
- Returns:
- The value of the
configs
attribute
-
getHeaderPathPrefix
public Optional<String> getHeaderPathPrefix()
- Specified by:
getHeaderPathPrefix
in interfaceAppleNativeTargetDescriptionArg
- Returns:
- The value of the
headerPathPrefix
attribute
-
isModular
public boolean isModular()
- Specified by:
isModular
in interfaceAppleNativeTargetDescriptionArg
- Returns:
- The value of the
modular
attribute
-
getModulemapMode
public Optional<ModuleMapMode> getModulemapMode()
A modulemap mode, to override the one specified in .buckconfig.- Specified by:
getModulemapMode
in interfaceAppleNativeTargetDescriptionArg
-
getTargetSdkVersion
public Optional<String> getTargetSdkVersion()
The minimum OS version for which this target should be built. If set, this will override the config-level option.- Specified by:
getTargetSdkVersion
in interfaceAppleNativeTargetDescriptionArg
-
getExportedHeaders
public SourceSortedSet getExportedHeaders()
- Specified by:
getExportedHeaders
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedHeaders
attribute
-
getExportedPlatformHeaders
public PatternMatchedCollection<SourceSortedSet> getExportedPlatformHeaders()
- Specified by:
getExportedPlatformHeaders
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedPlatformHeaders
attribute
-
getExportedPreprocessorFlags
public com.google.common.collect.ImmutableList<StringWithMacros> getExportedPreprocessorFlags()
- Specified by:
getExportedPreprocessorFlags
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedPreprocessorFlags
attribute
-
getExportedPlatformPreprocessorFlags
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getExportedPlatformPreprocessorFlags()
- Specified by:
getExportedPlatformPreprocessorFlags
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedPlatformPreprocessorFlags
attribute
-
getExportedLangPreprocessorFlags
public com.google.common.collect.ImmutableMap<CxxSource.Type,com.google.common.collect.ImmutableList<StringWithMacros>> getExportedLangPreprocessorFlags()
- Specified by:
getExportedLangPreprocessorFlags
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedLangPreprocessorFlags
attribute
-
getExportedLangPlatformPreprocessorFlags
public com.google.common.collect.ImmutableMap<CxxSource.Type,PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>> getExportedLangPlatformPreprocessorFlags()
- Specified by:
getExportedLangPlatformPreprocessorFlags
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedLangPlatformPreprocessorFlags
attribute
-
getExportedLinkerFlags
public com.google.common.collect.ImmutableList<StringWithMacros> getExportedLinkerFlags()
- Specified by:
getExportedLinkerFlags
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedLinkerFlags
attribute
-
getExportedPostLinkerFlags
public com.google.common.collect.ImmutableList<StringWithMacros> getExportedPostLinkerFlags()
- Specified by:
getExportedPostLinkerFlags
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedPostLinkerFlags
attribute
-
getExportedPlatformLinkerFlags
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getExportedPlatformLinkerFlags()
- Specified by:
getExportedPlatformLinkerFlags
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedPlatformLinkerFlags
attribute
-
getExportedPostPlatformLinkerFlags
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getExportedPostPlatformLinkerFlags()
- Specified by:
getExportedPostPlatformLinkerFlags
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedPostPlatformLinkerFlags
attribute
-
getExportedDeps
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getExportedDeps()
- Specified by:
getExportedDeps
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedDeps
attribute
-
getExportedPlatformDeps
public PatternMatchedCollection<com.google.common.collect.ImmutableSortedSet<BuildTarget>> getExportedPlatformDeps()
- Specified by:
getExportedPlatformDeps
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
exportedPlatformDeps
attribute
-
getSupportedPlatformsRegex
public Optional<Pattern> getSupportedPlatformsRegex()
- Specified by:
getSupportedPlatformsRegex
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
supportedPlatformsRegex
attribute
-
getSoname
public Optional<String> getSoname()
- Specified by:
getSoname
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
soname
attribute
-
getStaticLibraryBasename
public Optional<String> getStaticLibraryBasename()
- Specified by:
getStaticLibraryBasename
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
staticLibraryBasename
attribute
-
getForceStatic
public Optional<Boolean> getForceStatic()
- Specified by:
getForceStatic
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
forceStatic
attribute
-
getLinkWhole
public Optional<Boolean> getLinkWhole()
- Specified by:
getLinkWhole
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
linkWhole
attribute
-
getCanBeAsset
public Optional<Boolean> getCanBeAsset()
- Specified by:
getCanBeAsset
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
canBeAsset
attribute
-
getPreferredLinkage
public Optional<NativeLinkableGroup.Linkage> getPreferredLinkage()
- Specified by:
getPreferredLinkage
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
preferredLinkage
attribute
-
getXcodePublicHeadersSymlinks
public Optional<Boolean> getXcodePublicHeadersSymlinks()
- Specified by:
getXcodePublicHeadersSymlinks
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
xcodePublicHeadersSymlinks
attribute
-
getXcodePrivateHeadersSymlinks
public Optional<Boolean> getXcodePrivateHeadersSymlinks()
- Specified by:
getXcodePrivateHeadersSymlinks
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
xcodePrivateHeadersSymlinks
attribute
-
getExtraXcodeSources
public com.google.common.collect.ImmutableList<SourcePath> getExtraXcodeSources()
extra_xcode_sources will add the files to the list of files to be compiled in the Xcode target.- Specified by:
getExtraXcodeSources
in interfaceCxxLibraryDescription.CommonArg
-
getExtraXcodeFiles
public com.google.common.collect.ImmutableList<SourcePath> getExtraXcodeFiles()
extra_xcode_sources will add the files to the list of files in the project and won't add them to an Xcode target.- Specified by:
getExtraXcodeFiles
in interfaceCxxLibraryDescription.CommonArg
-
isReexportAllHeaderDependencies
public Optional<Boolean> isReexportAllHeaderDependencies()
Controls whether the headers of dependencies in "deps" is re-exported for compiling targets that depend on this one.- Specified by:
isReexportAllHeaderDependencies
in interfaceCxxLibraryDescription.CommonArg
-
getBridgingHeader
public Optional<SourcePath> getBridgingHeader()
These fields are passed through to SwiftLibrary for mixed C/Swift targets; they are not used otherwise.- Specified by:
getBridgingHeader
in interfaceCxxLibraryDescription.CommonArg
-
getModuleName
public Optional<String> getModuleName()
- Specified by:
getModuleName
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
moduleName
attribute
-
getPublicIncludeDirectories
public com.google.common.collect.ImmutableSortedSet<String> getPublicIncludeDirectories()
A list of include directories to be added to the compile command for compiling this cxx target and every target that depends on it.- Specified by:
getPublicIncludeDirectories
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- a list of public (exported) include paths for this cxx target.
-
getPublicSystemIncludeDirectories
public com.google.common.collect.ImmutableSortedSet<String> getPublicSystemIncludeDirectories()
A list of include directories to be added to the compile command for compiling this cxx target and every target that depends on it.- Specified by:
getPublicSystemIncludeDirectories
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- a list of public (exported) include paths for this cxx target.
-
getExportedCxxDeps
public CxxDeps getExportedCxxDeps()
- Specified by:
getExportedCxxDeps
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- C/C++ deps which are propagated to dependents.
-
getCxxDeps
public CxxDeps getCxxDeps()
Override parent class's deps to include exported deps.- Specified by:
getCxxDeps
in interfaceCxxConstructorArg
- Specified by:
getCxxDeps
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- the C/C++ deps this rule builds against.
-
getExportedHeaderStyle
public CxxPreprocessables.IncludeType getExportedHeaderStyle()
- Specified by:
getExportedHeaderStyle
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- how exported headers from this rule should be included by dependents.
-
getSupportsMergedLinking
public Optional<Boolean> getSupportsMergedLinking()
- Specified by:
getSupportsMergedLinking
in interfaceCxxLibraryDescription.CommonArg
- Returns:
- The value of the
supportsMergedLinking
attribute
-
getLinkStyle
public Optional<Linker.LinkableDepType> getLinkStyle()
- Specified by:
getLinkStyle
in interfaceLinkableCxxConstructorArg
- Returns:
- The value of the
linkStyle
attribute
-
getLinkGroupMap
public Optional<com.google.common.collect.ImmutableList<CxxLinkGroupMapping>> getLinkGroupMap()
Defines the list of link group mappings. Targets' membership in a group is defined by the order of the list, so if more than one mapping matches a single target, the group would be the one defined by the first match.- Specified by:
getLinkGroupMap
in interfaceLinkableCxxConstructorArg
-
getLinkGroup
public Optional<String> getLinkGroup()
Defines the link group. When linking executable code, only static libraries which belong to the same group would be linked into the executable.- Specified by:
getLinkGroup
in interfaceLinkableCxxConstructorArg
-
getThinLto
public boolean getThinLto()
- Specified by:
getThinLto
in interfaceLinkableCxxConstructorArg
- Returns:
- The value of the
thinLto
attribute
-
getFatLto
public boolean getFatLto()
- Specified by:
getFatLto
in interfaceLinkableCxxConstructorArg
- Returns:
- The value of the
fatLto
attribute
-
getSrcs
public com.google.common.collect.ImmutableSortedSet<SourceWithFlags> getSrcs()
- Specified by:
getSrcs
in interfaceCxxConstructorArg
- Returns:
- The value of the
srcs
attribute
-
getPlatformSrcs
public PatternMatchedCollection<com.google.common.collect.ImmutableSortedSet<SourceWithFlags>> getPlatformSrcs()
- Specified by:
getPlatformSrcs
in interfaceCxxConstructorArg
- Returns:
- The value of the
platformSrcs
attribute
-
getHeaders
public SourceSortedSet getHeaders()
- Specified by:
getHeaders
in interfaceCxxConstructorArg
- Returns:
- The value of the
headers
attribute
-
getRawHeaders
public com.google.common.collect.ImmutableSortedSet<SourcePath> getRawHeaders()
Raw headers are headers which are used as they are (via compilation flags). Buck doesn't copy them or create symlinks for them. They are public (since managed by compilation flags).- Specified by:
getRawHeaders
in interfaceCxxConstructorArg
- Returns:
- a list of raw headers
-
getIncludeDirectories
public com.google.common.collect.ImmutableSortedSet<String> getIncludeDirectories()
A list of include directories to be added to the compile command for compiling this cxx target.- Specified by:
getIncludeDirectories
in interfaceCxxConstructorArg
- Returns:
- a list of private include paths for this cxx target.
-
getPlatformHeaders
public PatternMatchedCollection<SourceSortedSet> getPlatformHeaders()
- Specified by:
getPlatformHeaders
in interfaceCxxConstructorArg
- Returns:
- The value of the
platformHeaders
attribute
-
getPrefixHeader
public Optional<SourcePath> getPrefixHeader()
- Specified by:
getPrefixHeader
in interfaceCxxConstructorArg
- Returns:
- The value of the
prefixHeader
attribute
-
getPrecompiledHeader
public Optional<SourcePath> getPrecompiledHeader()
- Specified by:
getPrecompiledHeader
in interfaceCxxConstructorArg
- Returns:
- The value of the
precompiledHeader
attribute
-
getCompilerFlags
public com.google.common.collect.ImmutableList<StringWithMacros> getCompilerFlags()
- Specified by:
getCompilerFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
compilerFlags
attribute
-
getLangCompilerFlags
public com.google.common.collect.ImmutableMap<CxxSource.Type,com.google.common.collect.ImmutableList<StringWithMacros>> getLangCompilerFlags()
- Specified by:
getLangCompilerFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
langCompilerFlags
attribute
-
getLangPlatformCompilerFlags
public com.google.common.collect.ImmutableMap<CxxSource.Type,PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>> getLangPlatformCompilerFlags()
- Specified by:
getLangPlatformCompilerFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
langPlatformCompilerFlags
attribute
-
getPlatformCompilerFlags
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getPlatformCompilerFlags()
- Specified by:
getPlatformCompilerFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
platformCompilerFlags
attribute
-
getPreprocessorFlags
public com.google.common.collect.ImmutableList<StringWithMacros> getPreprocessorFlags()
- Specified by:
getPreprocessorFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
preprocessorFlags
attribute
-
getPlatformPreprocessorFlags
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getPlatformPreprocessorFlags()
- Specified by:
getPlatformPreprocessorFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
platformPreprocessorFlags
attribute
-
getLangPreprocessorFlags
public com.google.common.collect.ImmutableMap<CxxSource.Type,com.google.common.collect.ImmutableList<StringWithMacros>> getLangPreprocessorFlags()
- Specified by:
getLangPreprocessorFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
langPreprocessorFlags
attribute
-
getLangPlatformPreprocessorFlags
public com.google.common.collect.ImmutableMap<CxxSource.Type,PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>>> getLangPlatformPreprocessorFlags()
- Specified by:
getLangPlatformPreprocessorFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
langPlatformPreprocessorFlags
attribute
-
getLinkerFlags
public com.google.common.collect.ImmutableList<StringWithMacros> getLinkerFlags()
- Specified by:
getLinkerFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
linkerFlags
attribute
-
getPostLinkerFlags
public com.google.common.collect.ImmutableList<StringWithMacros> getPostLinkerFlags()
- Specified by:
getPostLinkerFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
postLinkerFlags
attribute
-
getLinkerExtraOutputs
public com.google.common.collect.ImmutableList<String> getLinkerExtraOutputs()
- Specified by:
getLinkerExtraOutputs
in interfaceCxxConstructorArg
- Returns:
- The value of the
linkerExtraOutputs
attribute
-
getPlatformLinkerFlags
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getPlatformLinkerFlags()
- Specified by:
getPlatformLinkerFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
platformLinkerFlags
attribute
-
getExecutableName
public Optional<String> getExecutableName()
- Specified by:
getExecutableName
in interfaceCxxConstructorArg
- Returns:
- The value of the
executableName
attribute
-
getPostPlatformLinkerFlags
public PatternMatchedCollection<com.google.common.collect.ImmutableList<StringWithMacros>> getPostPlatformLinkerFlags()
- Specified by:
getPostPlatformLinkerFlags
in interfaceCxxConstructorArg
- Returns:
- The value of the
postPlatformLinkerFlags
attribute
-
getPlatformDeps
public PatternMatchedCollection<com.google.common.collect.ImmutableSortedSet<BuildTarget>> getPlatformDeps()
- Specified by:
getPlatformDeps
in interfaceCxxConstructorArg
- Returns:
- The value of the
platformDeps
attribute
-
getHeaderNamespace
public Optional<String> getHeaderNamespace()
- Specified by:
getHeaderNamespace
in interfaceCxxConstructorArg
- Returns:
- The value of the
headerNamespace
attribute
-
getCxxRuntimeType
public Optional<Linker.CxxRuntimeType> getCxxRuntimeType()
- Specified by:
getCxxRuntimeType
in interfaceCxxConstructorArg
- Returns:
- The value of the
cxxRuntimeType
attribute
-
getDefaults
public com.google.common.collect.ImmutableMap<String,Flavor> getDefaults()
- Specified by:
getDefaults
in interfaceCxxConstructorArg
- Returns:
- The value of the
defaults
attribute
-
getDefaultFlavors
public com.google.common.collect.ImmutableSortedSet<Flavor> getDefaultFlavors()
- Specified by:
getDefaultFlavors
in interfaceCxxConstructorArg
- Specified by:
getDefaultFlavors
in interfaceHasDefaultFlavors
- Returns:
- The computed-at-construction value of the
defaultFlavors
attribute
-
getPrivateCxxDeps
public CxxDeps getPrivateCxxDeps()
- Specified by:
getPrivateCxxDeps
in interfaceCxxConstructorArg
- Returns:
- C/C++ deps which are *not* propagated to dependents.
-
getLicenses
public com.google.common.collect.ImmutableSet<SourcePath> getLicenses()
- Specified by:
getLicenses
in interfaceBuildRuleArg
- Returns:
- The value of the
licenses
attribute
-
getLabels
public com.google.common.collect.ImmutableSortedSet<String> getLabels()
- Specified by:
getLabels
in interfaceBuildRuleArg
- Returns:
- The value of the
labels
attribute
-
getDefaultTargetPlatform
public Optional<UnconfiguredBuildTarget> getDefaultTargetPlatform()
The name of build target default "new" platform: it is used when a platform is not specified either globally or in a target which used this target as a dependency.The value is a build target, but we specify it as string, because this function is not actually called, but the attr is fetched by name from the raw (unconfigured) target node.
- Specified by:
getDefaultTargetPlatform
in interfaceBuildRuleArg
-
getCompatibleWith
public com.google.common.collect.ImmutableList<UnconfiguredBuildTarget> getCompatibleWith()
A list ofconfig_setting
a target is compatible with.- Specified by:
getCompatibleWith
in interfaceBuildRuleArg
-
getName
public String getName()
Each rule has a name- Specified by:
getName
in interfaceConstructorArg
-
getDeps
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getDeps()
- Specified by:
getDeps
in interfaceHasDeclaredDeps
- Returns:
- The value of the
deps
attribute
-
getDefaultPlatform
public Optional<Flavor> getDefaultPlatform()
- Specified by:
getDefaultPlatform
in interfaceHasDefaultPlatform
- Returns:
- If present, the default platform with which to build this target if none are provided on the command line.
-
getTests
public com.google.common.collect.ImmutableSortedSet<BuildTarget> getTests()
-
getFrameworks
public com.google.common.collect.ImmutableSortedSet<FrameworkPath> getFrameworks()
- Specified by:
getFrameworks
in interfaceHasSystemFrameworkAndLibraries
- Returns:
- The value of the
frameworks
attribute
-
getLibraries
public com.google.common.collect.ImmutableSortedSet<FrameworkPath> getLibraries()
- Specified by:
getLibraries
in interfaceHasSystemFrameworkAndLibraries
- Returns:
- The value of the
libraries
attribute
-
getSwiftCompilerFlags
public com.google.common.collect.ImmutableList<StringWithMacros> getSwiftCompilerFlags()
- Specified by:
getSwiftCompilerFlags
in interfaceSwiftCommonArg
- Returns:
- The value of the
swiftCompilerFlags
attribute
-
getSwiftVersion
public Optional<String> getSwiftVersion()
- Specified by:
getSwiftVersion
in interfaceSwiftCommonArg
- Returns:
- The value of the
swiftVersion
attribute
-
getInfoPlist
public SourcePath getInfoPlist()
- Specified by:
getInfoPlist
in interfaceHasAppleBundleFields
- Returns:
- The value of the
infoPlist
attribute
-
getXcodeProductType
public Optional<String> getXcodeProductType()
- Specified by:
getXcodeProductType
in interfaceHasAppleBundleFields
- Returns:
- The value of the
xcodeProductType
attribute
-
getIsAppClip
public Optional<Boolean> getIsAppClip()
- Specified by:
getIsAppClip
in interfaceHasAppleBundleFields
- Returns:
- The value of the
isAppClip
attribute
-
getInfoPlistSubstitutions
public com.google.common.collect.ImmutableMap<String,String> getInfoPlistSubstitutions()
- Specified by:
getInfoPlistSubstitutions
in interfaceHasAppleBundleFields
- Returns:
- The value of the
infoPlistSubstitutions
attribute
-
getAssetCatalogsCompilationOptions
public AppleAssetCatalogsCompilationOptions getAssetCatalogsCompilationOptions()
- Specified by:
getAssetCatalogsCompilationOptions
in interfaceHasAppleBundleFields
- Returns:
- The value of the
assetCatalogsCompilationOptions
attribute
-
getCodesignFlags
public com.google.common.collect.ImmutableList<String> getCodesignFlags()
- Specified by:
getCodesignFlags
in interfaceHasAppleCodesignFields
- Returns:
- Additional flags passed to the underlying codesign tool. For example, this can be used to sign deep macOS frameworks using "--deep".
-
getCodesignIdentity
public Optional<String> getCodesignIdentity()
- Specified by:
getCodesignIdentity
in interfaceHasAppleCodesignFields
- Returns:
- A codesign identity that will be used for adhoc signing (i.e., on platforms like macOS and simulators). This field can be used to sign with Developer ID on macOS.
-
getContacts
public com.google.common.collect.ImmutableSortedSet<String> getContacts()
- Specified by:
getContacts
in interfaceHasContacts
- Returns:
- The value of the
contacts
attribute
-
getEntitlementsFile
public Optional<SourcePath> getEntitlementsFile()
- Specified by:
getEntitlementsFile
in interfaceHasEntitlementsFile
- Returns:
- The value of the
entitlementsFile
attribute
-
getTestRuleTimeoutMs
public Optional<Long> getTestRuleTimeoutMs()
- Specified by:
getTestRuleTimeoutMs
in interfaceHasTestTimeout
- Returns:
- The value of the
testRuleTimeoutMs
attribute
-
getRunner
public Optional<BuildTarget> getRunner()
- Specified by:
getRunner
in interfaceHasTestRunner
- Returns:
- the target to the library containing the test runner
-
getSpecs
public Optional<TestRunnerSpec> getSpecs()
- Specified by:
getSpecs
in interfaceHasTestRunner
- Returns:
- the freeform (for now) specs as required for running tests. For example, cmds, contacts, etc. This is serialized as json for for the external test runner.
-
equals
public boolean equals(@Nullable Object another)
This instance is equal to all instances ofAppleTestDescriptionArg
that have equal attribute values.
-
hashCode
public int hashCode()
Computes a hash code from attributes:runTestSeparately
,isUiTest
,testHostApp
,uiTestTargetApp
,snapshotReferenceImagesPath
,snapshotImagesDiffPath
,destinationSpecifier
,env
,configs
,headerPathPrefix
,modular
,modulemapMode
,targetSdkVersion
,exportedHeaders
,exportedPlatformHeaders
,exportedPreprocessorFlags
,exportedPlatformPreprocessorFlags
,exportedLangPreprocessorFlags
,exportedLangPlatformPreprocessorFlags
,exportedLinkerFlags
,exportedPostLinkerFlags
,exportedPlatformLinkerFlags
,exportedPostPlatformLinkerFlags
,exportedDeps
,exportedPlatformDeps
,supportedPlatformsRegex
,soname
,staticLibraryBasename
,forceStatic
,linkWhole
,canBeAsset
,preferredLinkage
,xcodePublicHeadersSymlinks
,xcodePrivateHeadersSymlinks
,extraXcodeSources
,extraXcodeFiles
,reexportAllHeaderDependencies
,bridgingHeader
,moduleName
,publicIncludeDirectories
,publicSystemIncludeDirectories
,exportedCxxDeps
,cxxDeps
,exportedHeaderStyle
,supportsMergedLinking
,linkStyle
,linkGroupMap
,linkGroup
,thinLto
,fatLto
,srcs
,platformSrcs
,headers
,rawHeaders
,includeDirectories
,platformHeaders
,prefixHeader
,precompiledHeader
,compilerFlags
,langCompilerFlags
,langPlatformCompilerFlags
,platformCompilerFlags
,preprocessorFlags
,platformPreprocessorFlags
,langPreprocessorFlags
,langPlatformPreprocessorFlags
,linkerFlags
,postLinkerFlags
,linkerExtraOutputs
,platformLinkerFlags
,executableName
,postPlatformLinkerFlags
,platformDeps
,headerNamespace
,cxxRuntimeType
,defaults
,defaultFlavors
,privateCxxDeps
,licenses
,labels
,defaultTargetPlatform
,compatibleWith
,name
,deps
,defaultPlatform
,tests
,frameworks
,libraries
,swiftCompilerFlags
,swiftVersion
,infoPlist
,xcodeProductType
,isAppClip
,infoPlistSubstitutions
,assetCatalogsCompilationOptions
,codesignFlags
,codesignIdentity
,contacts
,entitlementsFile
,testRuleTimeoutMs
,runner
,specs
.
-
toString
public String toString()
Prints the immutable valueAppleTestDescriptionArg
with attribute values.
-
builder
public static AppleTestDescriptionArg.Builder builder()
Creates a builder forAppleTestDescriptionArg
.- Returns:
- A new AppleTestDescriptionArg builder
-
getExtension
public default Either<AppleBundleExtension,String> getExtension()
- Specified by:
getExtension
in interfaceHasAppleBundleFields
-
getProductName
public default Optional<String> getProductName()
- Specified by:
getProductName
in interfaceHasAppleBundleFields
-
-