build-system/gradle-core/src/main/java/com/android/build/gradle/internal/scope/ArtifactTypeUtil.kt

/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

@file:JvmName("ArtifactTypeUtil")
package com.android.build.gradle.internal.scope

import com.android.build.api.artifact.ArtifactType
import com.android.utils.FileUtils
import org.gradle.api.file.Directory
import org.gradle.api.file.DirectoryProperty
import java.io.File

/**
 * Returns a suitable output directory for this receiving artifact type.
 * This folder will be independent of variant or tasks names and should be further qualified
 * if necessary.
 *
 * @param parentFile the parent directory.
 */
fun ArtifactType<*>.getOutputDir(parentFile: File)=
    File(
        if (this is InternalArtifactType) {
            category.getOutputDir(parentFile)
        } else {
            InternalArtifactType.Category.INTERMEDIATES.getOutputDir(parentFile)
        },
        getFolderName()
    )

/**
 * Returns a relative path to the build directory for this artifact type.
 *
 * @return a relative path
 */
fun ArtifactType<*>.getOutputPath() =
    if (this is InternalArtifactType) {
        category.outputPath
    } else {
        InternalArtifactType.Category.INTERMEDIATES.outputPath
    }

/**
 * Returns a [File] representing the parent directory for an artifact type location.
 *
 * @param buildDirectory the parent build folder
 * @param identifier the unique scoping identifier
 * @param taskName the task name to append to the path, or null if not necessary
 *
 * @return a [File] that can be safely use as task output.
 */
fun ArtifactType<*>.getOutputDirectory(
    buildDirectory: DirectoryProperty,
    vararg paths: String) = FileUtils.join(
        getOutputDir(buildDirectory.get().asFile),
        *paths
    )