| /* |
| * Copyright 2022 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 androidx.baselineprofiles.gradle.consumer |
| |
| import org.gradle.api.Action |
| import org.gradle.api.Project |
| |
| /** |
| * Allows specifying settings for the Baseline Profiles Plugin. |
| */ |
| open class BaselineProfilesConsumerExtension { |
| |
| companion object { |
| |
| private const val EXTENSION_NAME = "baselineProfilesProfileConsumer" |
| |
| internal fun registerExtension(project: Project): BaselineProfilesConsumerExtension { |
| val ext = project.extensions.findByType(BaselineProfilesConsumerExtension::class.java) |
| if (ext != null) { |
| return ext |
| } |
| return project |
| .extensions.create(EXTENSION_NAME, BaselineProfilesConsumerExtension::class.java) |
| } |
| } |
| |
| /** |
| * Specifies what build type should be used to generate baseline profiles. By default this build |
| * type is `release`. In general, this should be a build type used for distribution. Note that |
| * this will be deprecated when b/265438201 is fixed, as all the build types will be used to |
| * generate baseline profiles. |
| */ |
| var buildTypeName: String = "release" |
| |
| /** |
| * Enables on-demand baseline profile generation. Baseline profiles can be generated |
| * periodically or on-demand. Setting this flag to true will enable on-demand generation. |
| * When on-demand generation is enabled the baseline profile is regenerated before building the |
| * release build type. Note that in on-demand mode the baseline profile file is NOT saved in |
| * the `src/<variant>/baselineProfiles` folder, as opposite to the periodic generation where the |
| * latest baseline profile is always stored in the sources. |
| */ |
| var onDemandGeneration = false |
| |
| /** |
| * When [onDemandGeneration] is off, baseline profiles are stored in the source folders, by |
| * default `src/<variant>/baselineProfiles`. The inner folder can be customized through this |
| * parameter. |
| */ |
| var baselineProfileDir = "generatedBaselineProfiles" |
| |
| /** |
| * Specifies a filtering rule to decide which profiles rules should be included in this |
| * consumer baseline profile. This is useful especially for libraries, in order to exclude |
| * profile rules for class and methods for dependencies of the sample app. The filter supports: |
| * - Double wildcards, to match specified package and subpackages. Example: `com.example.**` |
| * - Wildcards, to match specified package only. Example: `com.example.*` |
| * - Class names, to match the specified class. Example: `com.example.MyClass` |
| * |
| * Note that when only excludes are specified, if there are no matches with any rule the profile |
| * rule is selected. |
| * |
| * Example to include a package and all the subpackages: |
| * ``` |
| * filter { include "com.somelibrary.**" } |
| * ``` |
| * |
| * Example to exclude some packages and include all the rest: |
| * ``` |
| * filter { exclude "com.somelibrary.debug" } |
| * ``` |
| * |
| * Example to include and exclude specific packages: |
| * ``` |
| * filter { |
| * include "com.somelibrary.widget.grid.**" |
| * exclude "com.somelibrary.widget.grid.debug.**" |
| * include "com.somelibrary.widget.list.**" |
| * exclude "com.somelibrary.widget.grid.debug.**" |
| * include "com.somelibrary.widget.text.**" |
| * exclude "com.somelibrary.widget.grid.debug.**" |
| * } |
| * ``` |
| * |
| * Filters also support variants and they can be expressed as follows: |
| * ``` |
| * filter { include "com.somelibrary.*" } |
| * filter("free") { include "com.somelibrary.*" } |
| * filter("paid") { include "com.somelibrary.*" } |
| * filter("release") { include "com.somelibrary.*" } |
| * filter("freeRelease") { include "com.somelibrary.*" } |
| * ``` |
| * Filter block without specifying a variant applies to `main`, i.e. all the variants. |
| * Note that when a variant matches multiple filter blocks, all the filters will be merged. |
| * For example with `filter { ... }`, `filter("free") { ... }` and `filter("release") { ... }` |
| * all the blocks will be evaluated for variant `freeRelease` but only `main` and `release` for |
| * variant `paidRelease`. |
| */ |
| @JvmOverloads |
| fun filter(variant: String = "main", action: FilterRules.() -> (Unit)) = action |
| .invoke(filterRules.computeIfAbsent(variant) { FilterRules() }) |
| |
| /** |
| * Specifies a filtering rule to decide which profiles rules should be included in this |
| * consumer baseline profile. This is useful especially for libraries, in order to exclude |
| * profile rules for class and methods for dependencies of the sample app. The filter supports: |
| * - Double wildcards, to match specified package and subpackages. Example: `com.example.**` |
| * - Wildcards, to match specified package only. Example: `com.example.*` |
| * - Class names, to match the specified class. Example: `com.example.MyClass` |
| * |
| * Note that when only excludes are specified, if there are no matches with any rule the profile |
| * rule is selected. |
| * |
| * Example to include a package and all the subpackages: |
| * ``` |
| * filter { include "com.somelibrary.**" } |
| * ``` |
| * |
| * Example to exclude some packages and include all the rest: |
| * ``` |
| * filter { exclude "com.somelibrary.debug" } |
| * ``` |
| * |
| * Example to include and exclude specific packages: |
| * ``` |
| * filter { |
| * include "com.somelibrary.widget.grid.**" |
| * exclude "com.somelibrary.widget.grid.debug.**" |
| * include "com.somelibrary.widget.list.**" |
| * exclude "com.somelibrary.widget.list.debug.**" |
| * include "com.somelibrary.widget.text.**" |
| * exclude "com.somelibrary.widget.text.debug.**" |
| * } |
| * ``` |
| * |
| * Filters also support variants and they can be expressed as follows: |
| * ``` |
| * filter { include "com.somelibrary.*" } |
| * filter("free") { include "com.somelibrary.*" } |
| * filter("paid") { include "com.somelibrary.*" } |
| * filter("release") { include "com.somelibrary.*" } |
| * filter("freeRelease") { include "com.somelibrary.*" } |
| * ``` |
| * Filter block without specifying a variant applies to `main`, i.e. all the variants. |
| * Note that when a variant matches multiple filter blocks, all the filters will be merged. |
| * For example with `filter { ... }`, `filter("free") { ... }` and `filter("release") { ... }` |
| * all the blocks will be evaluated for variant `freeRelease` but only `main` and `release` for |
| * variant `paidRelease`. |
| */ |
| @JvmOverloads |
| fun filter(variant: String = "main", action: Action<FilterRules>) = action |
| .execute(filterRules.computeIfAbsent(variant) { FilterRules() }) |
| |
| internal val filterRules = mutableMapOf<String, FilterRules>() |
| } |
| |
| class FilterRules { |
| internal val rules = mutableListOf<Pair<RuleType, String>>() |
| fun include(pkg: String) = rules.add(Pair(RuleType.INCLUDE, pkg)) |
| fun exclude(pkg: String) = rules.add(Pair(RuleType.EXCLUDE, pkg)) |
| } |
| |
| enum class RuleType { |
| INCLUDE, |
| EXCLUDE |
| } |
