com.facebook.buck.android

Class AndroidBuckConfig

java.lang.Object

com.facebook.buck.android.AndroidBuckConfig

public class AndroidBuckConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AndroidBuckConfig.NdkSearchOrderEntry Values acceptable for ndk.ndk_search_order.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_ENTRY_IN_ADB_PATH_SEARCH_ORDER
static String	SDK_ENTRY_IN_ADB_PATH_SEARCH_ORDER
static com.google.common.collect.ImmutableSet<String>	VALID_ABI_KEYS

Constructor Summary

Constructors

Constructor and Description
AndroidBuckConfig(BuckConfig delegate, Platform platform)

Method Summary

Modifier and Type	Method and Description
Optional<ToolProvider>	getAapt2Override() Returns the tool provider to the platform specific aapt2 executable that is overridden by the current project.
boolean	getAaptNoResourceRemoval() Whether to disable resource removal in aapt2.
Optional<java.util.function.Supplier<Tool>>	getAaptOverride() Returns the path to the platform specific aapt executable that is overridden by the current project.
Optional<Path>	getAdbOverride() Returns the path to the adb executable overridden by the current project.
com.google.common.collect.ImmutableList<String>	getAdbSearchOrder() Defines the order to search for the adb executable: a list consisting of the elements '', representing the first adb on the system PATH, or '', representing the adb in the platform-tools directory of the currently configured Android SDK location.
Integer	getAdbTimeout()
Optional<String>	getAndroidCompileSdkVersion()
Optional<String>	getBuildToolsVersion()
com.google.common.collect.ImmutableList<String>	getExtraNdkCFlags()
com.google.common.collect.ImmutableList<String>	getExtraNdkCxxFlags()
com.google.common.collect.ImmutableList<String>	getExtraNdkLdFlags()
boolean	getFailOnLegacyAaptErrors() Whether to fail (vs warn) on legacy aapt2 compile errors.
Optional<String>	getNdkAppPlatformForCpuAbi(String cpuAbi) Returns the CPU specific app platform, or the fallback one if set.
Optional<String>	getNdkClangVersion()
Optional<NdkCompilerType>	getNdkCompiler()
com.google.common.collect.ImmutableMap<String,String>	getNdkCpuAbiAppPlatformMap()
Optional<String>	getNdkCpuAbiFallbackAppPlatform()
Optional<com.google.common.collect.ImmutableSet<NdkTargetArchAbi>>	getNdkCpuAbis()
Optional<NdkCxxRuntime>	getNdkCxxRuntime()
Optional<NdkCxxRuntimeType>	getNdkCxxRuntimeType()
Optional<BuildTarget>	getNdkCxxToolchainTargetForAbi(NdkTargetArchAbi cpuAbi, TargetConfiguration targetConfiguration) Gets the ndk_toolchain target for the abi if it is specified in the config.
Optional<String>	getNdkGccVersion()
Optional<String>	getNdkPath()
Optional<String>	getNdkRepositoryPath()
com.google.common.collect.ImmutableList<AndroidBuckConfig.NdkSearchOrderEntry>	getNdkSearchOrder() Defines the order of search of the Android NDK.
Optional<Boolean>	getNdkUnifiedHeaders()
Optional<String>	getNdkVersion()
Optional<BuildTarget>	getRedexTarget(TargetConfiguration targetConfiguration)
Tool	getRedexTool(BuildRuleResolver buildRuleResolver, TargetConfiguration targetConfiguration)
Optional<String>	getSdkPath()
Optional<String>	getSdkPathConfigOptionFromSearchOrderEntry(String entry) Given the entry to from the order of search of the Android SDK location returns the name of the configuration option that contains SDK path if the entry instructs to get that value from .buckconfig (i.e.
com.google.common.collect.ImmutableList<String>	getSdkPathSearchOrder() Defines the order of search of the path to Android SDK.
Optional<Boolean>	getSkipCrunchPngsDefault() Whether to skip crunching pngs by default in aapt2 compile.
boolean	isGrayscaleImageProcessingEnabled()

Methods inherited from class java.lang.Object

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

Field Detail

PATH_ENTRY_IN_ADB_PATH_SEARCH_ORDER

public static final String PATH_ENTRY_IN_ADB_PATH_SEARCH_ORDER

See Also:

Constant Field Values

SDK_ENTRY_IN_ADB_PATH_SEARCH_ORDER

public static final String SDK_ENTRY_IN_ADB_PATH_SEARCH_ORDER

See Also:

Constant Field Values

VALID_ABI_KEYS

public static final com.google.common.collect.ImmutableSet<String> VALID_ABI_KEYS

Constructor Detail

AndroidBuckConfig

public AndroidBuckConfig(BuckConfig delegate,
                         Platform platform)

Method Detail

getSkipCrunchPngsDefault

public Optional<Boolean> getSkipCrunchPngsDefault()

Whether to skip crunching pngs by default in aapt2 compile.

getFailOnLegacyAaptErrors

public boolean getFailOnLegacyAaptErrors()

Whether to fail (vs warn) on legacy aapt2 compile errors.

getAaptNoResourceRemoval

public boolean getAaptNoResourceRemoval()

Whether to disable resource removal in aapt2.

getAndroidCompileSdkVersion

public Optional<String> getAndroidCompileSdkVersion()

getBuildToolsVersion

public Optional<String> getBuildToolsVersion()

getAdbOverride

public Optional<Path> getAdbOverride()

Returns the path to the adb executable overridden by the current project. If not specified, the getAdbSearchOrder() will be used to find adb.

getAdbSearchOrder

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

Defines the order to search for the adb executable: a list consisting of the elements '', representing the first adb on the system PATH, or '', representing the adb in the platform-tools directory of the currently configured Android SDK location.

getAdbTimeout

public Integer getAdbTimeout()

getSdkPath

public Optional<String> getSdkPath()

getSdkPathSearchOrder

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

Defines the order of search of the path to Android SDK.

The order is the list of elements that can either be <CONFIG> (to indicate the entry from .buckconfig) or the name of an environment variable that contains path to Android SDK (for example, ANDROID_SDK).

If nothing is specified in .buckconfig the default order is: ANDROID_SDK, ANDROID_HOME, ANDROID_SDK_ROOT, <CONFIG>

getSdkPathConfigOptionFromSearchOrderEntry

public Optional<String> getSdkPathConfigOptionFromSearchOrderEntry(String entry)

Given the entry to from the order of search of the Android SDK location returns the name of the configuration option that contains SDK path if the entry instructs to get that value from .buckconfig (i.e. it's <CONFIG>) or Optional.empty() in other cases.

getNdkVersion

public Optional<String> getNdkVersion()

getNdkPath

public Optional<String> getNdkPath()

getNdkRepositoryPath

public Optional<String> getNdkRepositoryPath()

getNdkSearchOrder

public com.google.common.collect.ImmutableList<AndroidBuckConfig.NdkSearchOrderEntry> getNdkSearchOrder()

Defines the order of search of the Android NDK.

The order is the list of elements that can either be <NDK_REPOSITORY_CONFIG> to indicate the entry ndk.ndk_repo_path from .buckconfig, <NDK_DIRECTORY_CONFIG> to indicate the entry ndk.ndk_path from .buckconfig, or the name of an environment variable that contains path to Android NDK (ANDROID_NDK, NDK_HOME or ANDROID_NDK_REPOSITORY).

If nothing is specified in .buckconfig the default order is: ANDROID_NDK_REPOSITORY, ANDROID_NDK, NDK_HOME, <NDK_REPOSITORY_CONFIG>, <NDK_DIRECTORY_CONFIG>

getNdkCpuAbiFallbackAppPlatform

public Optional<String> getNdkCpuAbiFallbackAppPlatform()

getNdkCpuAbiAppPlatformMap

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

getNdkCpuAbis

public Optional<com.google.common.collect.ImmutableSet<NdkTargetArchAbi>> getNdkCpuAbis()

getNdkCompiler

public Optional<NdkCompilerType> getNdkCompiler()

getNdkGccVersion

public Optional<String> getNdkGccVersion()

getNdkClangVersion

public Optional<String> getNdkClangVersion()

getNdkCxxRuntime

public Optional<NdkCxxRuntime> getNdkCxxRuntime()

getNdkCxxRuntimeType

public Optional<NdkCxxRuntimeType> getNdkCxxRuntimeType()

getExtraNdkCFlags

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

getExtraNdkCxxFlags

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

getExtraNdkLdFlags

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

getNdkUnifiedHeaders

public Optional<Boolean> getNdkUnifiedHeaders()

isGrayscaleImageProcessingEnabled

public boolean isGrayscaleImageProcessingEnabled()

getNdkAppPlatformForCpuAbi

public Optional<String> getNdkAppPlatformForCpuAbi(String cpuAbi)

Returns the CPU specific app platform, or the fallback one if set. If neither are set, returns `Optional.empty` instead of a default value so callers can determine the difference between user-set and buck defaults.

getNdkCxxToolchainTargetForAbi

public Optional<BuildTarget> getNdkCxxToolchainTargetForAbi(NdkTargetArchAbi cpuAbi,
                                                            TargetConfiguration targetConfiguration)

Gets the ndk_toolchain target for the abi if it is specified in the config.

getAaptOverride

public Optional<java.util.function.Supplier<Tool>> getAaptOverride()

Returns the path to the platform specific aapt executable that is overridden by the current project. If not specified, the Android platform aapt will be used.

getAapt2Override

public Optional<ToolProvider> getAapt2Override()

Returns the tool provider to the platform specific aapt2 executable that is overridden by the current project. If not specified, the Android platform aapt will be used.

getRedexTarget

public Optional<BuildTarget> getRedexTarget(TargetConfiguration targetConfiguration)

getRedexTool

public Tool getRedexTool(BuildRuleResolver buildRuleResolver,
                         TargetConfiguration targetConfiguration)