build-system/gradle-api/src/main/java/com/android/build/api/dsl/JniLibsPackaging.kt

/*
 * Copyright (C) 2020 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.
 */

package com.android.build.api.dsl

import org.gradle.api.Incubating

/**
 * Packaging options for native library (.so) files in the Android DSL
 *
 * ```kotlin
 * android {
 *     packaging {
 *         jniLibs {
 *             excludes += ...
 *         }
 *     }
 * }
 * ```
 */
interface JniLibsPackaging {
    /**
     * Whether to use the legacy convention of compressing all .so files in the APK. If null, .so
     * files will be uncompressed and page-aligned when minSdk >= 23.
     */
    var useLegacyPackaging: Boolean?

    /**
     * The set of excluded patterns. Native libraries matching any of these patterns do not get
     * packaged.
     *
     * Example: `android.packagingOptions.jniLibs.excludes += "**`/`exclude.so"`
     */
    val excludes: MutableSet<String>

    /**
     * The set of patterns where the first occurrence is packaged in the APK. For each native
     * library APK entry path matching one of these patterns, only the first native library found
     * with that path gets packaged.
     *
     * Example: `android.packagingOptions.jniLibs.pickFirsts += "**`/`pickFirst.so"`
     */
    val pickFirsts: MutableSet<String>

    /**
     * The set of patterns for native libraries that should not be stripped of debug symbols.
     *
     * Example: `android.packagingOptions.jniLibs.keepDebugSymbols += "**`/`doNotStrip.so"`
     */
    val keepDebugSymbols: MutableSet<String>

    /**
     * The set of test-only patterns. Native libraries matching any of these patterns do not get
     * packaged in the main APK or AAR, but they are included in the test APK.
     *
     * Example: `android.packaging.jniLibs.testOnly += "**`/`testOnly.so"`
     */
    val testOnly: MutableSet<String>
}