com.android.build.gradle.tasks

Class ExternalNativeBuildTaskUtils

java.lang.Object

com.android.build.gradle.tasks.ExternalNativeBuildTaskUtils

public class ExternalNativeBuildTaskUtils
extends java.lang.Object

Shared utility methods for dealing with external native build tasks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalNativeBuildTaskUtils.ExternalNativeBuildProjectPathResolution

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUSTOM_FORK_CMAKE_VERSION

Constructor Summary

Constructors

Constructor and Description
ExternalNativeBuildTaskUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	executeBuildProcessAndLogError(com.android.builder.core.AndroidBuilder androidBuilder, com.android.ide.common.process.ProcessInfoBuilder process, boolean logStdioToInfo, java.lang.String logPrefix) Execute an external process and log the result in the case of a process exceptions.
static boolean	fileIsUpToDate(java.io.File source, java.io.File derived) File 'derived' is consider to depend on the contents of file 'source' this function return true if source is more recent than derived.
static java.io.File	findCmakeExecutableFolder(java.lang.String cmakeVersion, com.android.build.gradle.internal.SdkHandler sdkHandler) Returns the folder with the CMake binary.
static java.io.File	getCompileCommandsJson(java.io.File jsonFolder, java.lang.String abi) Utility function that gets the name of the output JSON for a particular ABI.
static java.io.File	getJsonMiniConfigFile(java.io.File originalJson) The json mini-config file contains a subset of the regular json file that is much smaller and less memory-intensive to read.
static java.io.File	getOutputJson(java.io.File jsonFolder, java.lang.String abi) Utility function that gets the name of the output JSON for a particular ABI.
static java.util.List<java.io.File>	getOutputJsons(java.io.File jsonFolder, java.util.Collection<java.lang.String> abis)
static ExternalNativeBuildTaskUtils.ExternalNativeBuildProjectPathResolution	getProjectPath(com.android.build.gradle.internal.model.CoreExternalNativeBuild config) Resolve the path of any native build project.
static boolean	isExternalNativeBuildEnabled(com.android.build.gradle.internal.model.CoreExternalNativeBuild config)
static boolean	shouldRegenerateOutOfDateJsons(ProjectOptions options) Return true if we should regenerate out-of-date JSON files.

Methods inherited from class java.lang.Object

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

Field Detail

CUSTOM_FORK_CMAKE_VERSION

public static final java.lang.String CUSTOM_FORK_CMAKE_VERSION

See Also:

Constant Field Values

Constructor Detail

ExternalNativeBuildTaskUtils

public ExternalNativeBuildTaskUtils()

Method Detail

fileIsUpToDate

public static boolean fileIsUpToDate(@NonNull
                                     java.io.File source,
                                     @NonNull
                                     java.io.File derived)
                              throws java.io.IOException

File 'derived' is consider to depend on the contents of file 'source' this function return true if source is more recent than derived.

If derived doesn't exist then it is not consider to be up-to-date with respect to source.

Parameters:

source - -- original file (must exist)

derived - -- derived file

Returns:

true if derived is more recent than original

Throws:

java.io.IOException - if there was a problem reading the timestampe of one of the files

getJsonMiniConfigFile

@NonNull
public static java.io.File getJsonMiniConfigFile(@NonNull
                                                          java.io.File originalJson)

The json mini-config file contains a subset of the regular json file that is much smaller and less memory-intensive to read.

getOutputJson

@NonNull
public static java.io.File getOutputJson(@NonNull
                                                  java.io.File jsonFolder,
                                                  @NonNull
                                                  java.lang.String abi)

Utility function that gets the name of the output JSON for a particular ABI.

getCompileCommandsJson

@NonNull
public static java.io.File getCompileCommandsJson(@NonNull
                                                           java.io.File jsonFolder,
                                                           @NonNull
                                                           java.lang.String abi)

Utility function that gets the name of the output JSON for a particular ABI.

getOutputJsons

@NonNull
public static java.util.List<java.io.File> getOutputJsons(@NonNull
                                                                   java.io.File jsonFolder,
                                                                   @NonNull
                                                                   java.util.Collection<java.lang.String> abis)

shouldRegenerateOutOfDateJsons

public static boolean shouldRegenerateOutOfDateJsons(@NonNull
                                                     ProjectOptions options)

Return true if we should regenerate out-of-date JSON files.

isExternalNativeBuildEnabled

public static boolean isExternalNativeBuildEnabled(@NonNull
                                                   com.android.build.gradle.internal.model.CoreExternalNativeBuild config)

getProjectPath

@NonNull
public static ExternalNativeBuildTaskUtils.ExternalNativeBuildProjectPathResolution getProjectPath(@NonNull
                                                                                                            com.android.build.gradle.internal.model.CoreExternalNativeBuild config)

Resolve the path of any native build project.

Parameters:

config - -- the AndroidConfig

Returns:

Path resolution.

executeBuildProcessAndLogError

@NonNull
public static java.lang.String executeBuildProcessAndLogError(@NonNull
                                                                       com.android.builder.core.AndroidBuilder androidBuilder,
                                                                       @NonNull
                                                                       com.android.ide.common.process.ProcessInfoBuilder process,
                                                                       boolean logStdioToInfo,
                                                                       @NonNull
                                                                       java.lang.String logPrefix)
                                                                throws com.android.ide.common.process.BuildCommandException,
                                                                       java.io.IOException

Execute an external process and log the result in the case of a process exceptions. Returns the info part of the log so that it can be parsed by ndk-build parser;

Throws:

com.android.ide.common.process.BuildCommandException - when the build failed.

java.io.IOException

findCmakeExecutableFolder

@NonNull
public static java.io.File findCmakeExecutableFolder(@NonNull
                                                              java.lang.String cmakeVersion,
                                                              @NonNull
                                                              com.android.build.gradle.internal.SdkHandler sdkHandler)

Returns the folder with the CMake binary. For more info, check the comments on doFindCmakeExecutableFolder below.

Parameters:

sdkHandler - sdk handler

Returns:

Folder with the required CMake binary