blob: 1a9da235de197564988641603a6b0b6b3caf38cb [file] [log] [blame]
Colin Crossfabb6082018-02-20 17:22:23 -08001// Copyright 2018 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17import (
Colin Crossa592e3e2019-02-19 16:59:53 -080018 "fmt"
Jaewoong Jung5b425e22019-06-17 17:40:56 -070019 "path/filepath"
Colin Cross312634e2023-11-21 15:13:56 -080020 "slices"
Colin Crossc20dc852020-11-10 12:27:45 -080021 "strconv"
Colin Crossa97c5d32018-03-28 14:58:31 -070022 "strings"
Colin Crossfabb6082018-02-20 17:22:23 -080023
Jaewoong Jung9befb0c2020-01-18 10:33:43 -080024 "android/soong/android"
Ulya Trafimovich31e444e2020-08-14 17:32:16 +010025 "android/soong/dexpreopt"
Colin Crossfabb6082018-02-20 17:22:23 -080026 "github.com/google/blueprint"
Colin Crossa97c5d32018-03-28 14:58:31 -070027 "github.com/google/blueprint/proptools"
Colin Crossfabb6082018-02-20 17:22:23 -080028)
29
Colin Crossa97c5d32018-03-28 14:58:31 -070030type AndroidLibraryDependency interface {
Colin Crossa97c5d32018-03-28 14:58:31 -070031 ExportPackage() android.Path
Colin Crossab8d1382023-07-14 17:23:41 +000032 ResourcesNodeDepSet() *android.DepSet[*resourcesNode]
33 RRODirsDepSet() *android.DepSet[rroDir]
34 ManifestsDepSet() *android.DepSet[android.Path]
Jaewoong Jungc779cd42020-10-06 18:56:10 -070035 SetRROEnforcedForDependent(enforce bool)
36 IsRROEnforced(ctx android.BaseModuleContext) bool
Colin Crossa97c5d32018-03-28 14:58:31 -070037}
38
39func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000040 RegisterAARBuildComponents(android.InitRegistrationContext)
41}
42
43func RegisterAARBuildComponents(ctx android.RegistrationContext) {
44 ctx.RegisterModuleType("android_library_import", AARImportFactory)
45 ctx.RegisterModuleType("android_library", AndroidLibraryFactory)
Paul Duffin04ba70d2021-03-22 13:56:43 +000046 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
47 ctx.TopDown("propagate_rro_enforcement", propagateRROEnforcementMutator).Parallel()
48 })
Colin Crossa97c5d32018-03-28 14:58:31 -070049}
50
51//
52// AAR (android library)
53//
54
55type androidLibraryProperties struct {
56 BuildAAR bool `blueprint:"mutated"`
57}
58
59type aaptProperties struct {
60 // flags passed to aapt when creating the apk
61 Aaptflags []string
62
Dan Willemsen72be5902018-10-24 20:24:57 -070063 // include all resource configurations, not just the product-configured
64 // ones.
65 Aapt_include_all_resources *bool
66
Jiakai Zhangba82e282023-10-13 18:08:59 +010067 // list of files to use as assets.
68 Assets []string `android:"path"`
69
Colin Crossa97c5d32018-03-28 14:58:31 -070070 // list of directories relative to the Blueprints file containing assets.
Colin Cross0ddae7f2019-02-07 15:30:01 -080071 // Defaults to ["assets"] if a directory called assets exists. Set to []
72 // to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070073 Asset_dirs []string
74
75 // list of directories relative to the Blueprints file containing
Colin Cross0ddae7f2019-02-07 15:30:01 -080076 // Android resources. Defaults to ["res"] if a directory called res exists.
77 // Set to [] to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070078 Resource_dirs []string
79
Colin Crossa592e3e2019-02-19 16:59:53 -080080 // list of zip files containing Android resources.
Colin Cross27b922f2019-03-04 22:35:41 -080081 Resource_zips []string `android:"path"`
Colin Crossa592e3e2019-02-19 16:59:53 -080082
Colin Crossa97c5d32018-03-28 14:58:31 -070083 // path to AndroidManifest.xml. If unset, defaults to "AndroidManifest.xml".
Colin Cross27b922f2019-03-04 22:35:41 -080084 Manifest *string `android:"path"`
changho.shinb5432b72019-08-08 18:37:17 +090085
86 // paths to additional manifest files to merge with main manifest.
87 Additional_manifests []string `android:"path"`
Sasha Smundak541056c2019-10-28 15:50:06 -070088
89 // do not include AndroidManifest from dependent libraries
90 Dont_merge_manifests *bool
Jaewoong Jungc779cd42020-10-06 18:56:10 -070091
Colin Cross4eae06d2023-06-20 22:40:02 -070092 // If use_resource_processor is set, use Bazel's resource processor instead of aapt2 to generate R.class files.
93 // The resource processor produces more optimal R.class files that only list resources in the package of the
94 // library that provided them, as opposed to aapt2 which produces R.java files for every package containing
95 // every resource. Using the resource processor can provide significant build time speedups, but requires
96 // fixing the module to use the correct package to reference each resource, and to avoid having any other
97 // libraries in the tree that use the same package name. Defaults to false, but will default to true in the
98 // future.
99 Use_resource_processor *bool
100
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700101 // true if RRO is enforced for any of the dependent modules
102 RROEnforcedForDependent bool `blueprint:"mutated"`
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900103
104 // Filter only specified product and ignore other products
105 Filter_product *string `blueprint:"mutated"`
Colin Crossa97c5d32018-03-28 14:58:31 -0700106}
107
108type aapt struct {
Colin Cross312634e2023-11-21 15:13:56 -0800109 aaptSrcJar android.Path
110 transitiveAaptRJars android.Paths
111 transitiveAaptResourcePackagesFile android.Path
112 exportPackage android.Path
113 manifestPath android.Path
114 proguardOptionsFile android.Path
115 rTxt android.Path
116 rJar android.Path
117 extraAaptPackagesFile android.Path
118 mergedManifestFile android.Path
119 noticeFile android.OptionalPath
120 assetPackage android.OptionalPath
121 isLibrary bool
122 defaultManifestVersion string
123 useEmbeddedNativeLibs bool
124 useEmbeddedDex bool
125 usesNonSdkApis bool
126 hasNoCode bool
127 LoggingParent string
128 resourceFiles android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700129
Colin Crosse560c4a2019-03-19 16:03:11 -0700130 splitNames []string
131 splits []split
132
Colin Crossa97c5d32018-03-28 14:58:31 -0700133 aaptProperties aaptProperties
Colin Crossab8d1382023-07-14 17:23:41 +0000134
135 resourcesNodesDepSet *android.DepSet[*resourcesNode]
136 rroDirsDepSet *android.DepSet[rroDir]
137 manifestsDepSet *android.DepSet[android.Path]
Alix96ea88452023-08-31 15:48:23 +0000138
139 manifestValues struct {
140 applicationId string
141 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700142}
143
Colin Crosse560c4a2019-03-19 16:03:11 -0700144type split struct {
145 name string
146 suffix string
147 path android.Path
148}
149
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700150// Propagate RRO enforcement flag to static lib dependencies transitively.
151func propagateRROEnforcementMutator(ctx android.TopDownMutatorContext) {
152 m := ctx.Module()
153 if d, ok := m.(AndroidLibraryDependency); ok && d.IsRROEnforced(ctx) {
154 ctx.VisitDirectDepsWithTag(staticLibTag, func(d android.Module) {
155 if a, ok := d.(AndroidLibraryDependency); ok {
156 a.SetRROEnforcedForDependent(true)
157 }
158 })
159 }
160}
161
Colin Cross4eae06d2023-06-20 22:40:02 -0700162func (a *aapt) useResourceProcessorBusyBox() bool {
163 return BoolDefault(a.aaptProperties.Use_resource_processor, false)
164}
165
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900166func (a *aapt) filterProduct() string {
167 return String(a.aaptProperties.Filter_product)
168}
169
Colin Crossa97c5d32018-03-28 14:58:31 -0700170func (a *aapt) ExportPackage() android.Path {
171 return a.exportPackage
172}
Colin Crossab8d1382023-07-14 17:23:41 +0000173func (a *aapt) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
174 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800175}
176
Colin Crossab8d1382023-07-14 17:23:41 +0000177func (a *aapt) RRODirsDepSet() *android.DepSet[rroDir] {
178 return a.rroDirsDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800179}
180
Colin Crossab8d1382023-07-14 17:23:41 +0000181func (a *aapt) ManifestsDepSet() *android.DepSet[android.Path] {
182 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800183}
184
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700185func (a *aapt) SetRROEnforcedForDependent(enforce bool) {
186 a.aaptProperties.RROEnforcedForDependent = enforce
187}
188
189func (a *aapt) IsRROEnforced(ctx android.BaseModuleContext) bool {
190 // True if RRO is enforced for this module or...
191 return ctx.Config().EnforceRROForModule(ctx.ModuleName()) ||
Jeongik Chacee5ba92021-02-19 12:11:51 +0900192 // if RRO is enforced for any of its dependents.
193 a.aaptProperties.RROEnforcedForDependent
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700194}
195
Jiyong Parkf1691d22021-03-29 20:11:58 +0900196func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext android.SdkContext,
Colin Crossa0ba2f52019-06-22 12:59:27 -0700197 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
198 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700199
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800200 hasVersionCode := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-code")
201 hasVersionName := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-name")
Colin Crossa97c5d32018-03-28 14:58:31 -0700202
Colin Crossa97c5d32018-03-28 14:58:31 -0700203 // Flags specified in Android.bp
204 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
205
Colin Crossa97c5d32018-03-28 14:58:31 -0700206 // Find implicit or explicit asset and resource dirs
Jiakai Zhangba82e282023-10-13 18:08:59 +0100207 assets := android.PathsRelativeToModuleSourceDir(android.SourceInput{
208 Context: ctx,
209 Paths: a.aaptProperties.Assets,
210 IncludeDirs: false,
211 })
Colin Crossa97c5d32018-03-28 14:58:31 -0700212 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
213 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800214 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700215
Colin Crossa97c5d32018-03-28 14:58:31 -0700216 // Glob directories into lists of paths
217 for _, dir := range resourceDirs {
218 resDirs = append(resDirs, globbedResourceDir{
219 dir: dir,
220 files: androidResourceGlob(ctx, dir),
221 })
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700222 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, a, dir)
Colin Crossa97c5d32018-03-28 14:58:31 -0700223 overlayDirs = append(overlayDirs, resOverlayDirs...)
224 rroDirs = append(rroDirs, resRRODirs...)
225 }
226
Colin Crossc20dc852020-11-10 12:27:45 -0800227 var assetDeps android.Paths
228 for i, dir := range assetDirs {
229 // Add a dependency on every file in the asset directory. This ensures the aapt2
230 // rule will be rerun if one of the files in the asset directory is modified.
231 assetDeps = append(assetDeps, androidResourceGlob(ctx, dir)...)
232
233 // Add a dependency on a file that contains a list of all the files in the asset directory.
234 // This ensures the aapt2 rule will be run if a file is removed from the asset directory,
235 // or a file is added whose timestamp is older than the output of aapt2.
236 assetFileListFile := android.PathForModuleOut(ctx, "asset_dir_globs", strconv.Itoa(i)+".glob")
237 androidResourceGlobList(ctx, dir, assetFileListFile)
238 assetDeps = append(assetDeps, assetFileListFile)
Colin Crossa97c5d32018-03-28 14:58:31 -0700239 }
240
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700241 assetDirStrings := assetDirs.Strings()
242 if a.noticeFile.Valid() {
243 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
Colin Crossc20dc852020-11-10 12:27:45 -0800244 assetDeps = append(assetDeps, a.noticeFile.Path())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700245 }
Jiakai Zhangba82e282023-10-13 18:08:59 +0100246 if len(assets) > 0 {
247 // aapt2 doesn't support adding individual asset files. Create a temp directory to hold asset
248 // files and pass it to aapt2.
249 tmpAssetDir := android.PathForModuleOut(ctx, "tmp_asset_dir")
250
251 rule := android.NewRuleBuilder(pctx, ctx)
252 rule.Command().
253 Text("rm -rf").Text(tmpAssetDir.String()).
254 Text("&&").
255 Text("mkdir -p").Text(tmpAssetDir.String())
256
257 for _, asset := range assets {
258 output := tmpAssetDir.Join(ctx, asset.Rel())
259 assetDeps = append(assetDeps, output)
260 rule.Command().Text("mkdir -p").Text(filepath.Dir(output.String()))
261 rule.Command().Text("cp").Input(asset).Output(output)
262 }
263
264 rule.Build("tmp_asset_dir", "tmp_asset_dir")
265
266 assetDirStrings = append(assetDirStrings, tmpAssetDir.String())
267 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700268
Colin Crossa97c5d32018-03-28 14:58:31 -0700269 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
270 linkDeps = append(linkDeps, manifestPath)
271
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700272 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossc20dc852020-11-10 12:27:45 -0800273 linkDeps = append(linkDeps, assetDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700274
Spandan Das50885c02023-02-23 21:31:33 +0000275 // Returns the effective version for {min|target}_sdk_version
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000276 effectiveVersionString := func(sdkVersion android.SdkSpec, minSdkVersion android.ApiLevel) string {
Spandan Das50885c02023-02-23 21:31:33 +0000277 // If {min|target}_sdk_version is current, use sdk_version to determine the effective level
278 // This is necessary for vendor modules.
279 // The effective version does not _only_ depend on {min|target}_sdk_version(level),
280 // but also on the sdk_version (kind+level)
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000281 if minSdkVersion.IsCurrent() {
Spandan Das50885c02023-02-23 21:31:33 +0000282 ret, err := sdkVersion.EffectiveVersionString(ctx)
283 if err != nil {
284 ctx.ModuleErrorf("invalid sdk_version: %s", err)
285 }
286 return ret
287 }
288 ret, err := minSdkVersion.EffectiveVersionString(ctx)
289 if err != nil {
290 ctx.ModuleErrorf("invalid min_sdk_version: %s", err)
291 }
292 return ret
Jiyong Park6a927c42020-01-21 02:03:43 +0900293 }
Spandan Das50885c02023-02-23 21:31:33 +0000294 // SDK version flags
295 sdkVersion := sdkContext.SdkVersion(ctx)
296 minSdkVersion := effectiveVersionString(sdkVersion, sdkContext.MinSdkVersion(ctx))
Colin Crossa97c5d32018-03-28 14:58:31 -0700297
Colin Cross83bb3162018-06-25 15:48:06 -0700298 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
Spandan Das6450b552023-02-23 19:27:07 +0000299 // Use minSdkVersion for target-sdk-version, even if `target_sdk_version` is set
300 // This behavior has been copied from Make.
Colin Cross83bb3162018-06-25 15:48:06 -0700301 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700302
Colin Crossa97c5d32018-03-28 14:58:31 -0700303 // Version code
304 if !hasVersionCode {
Dan Albert4f378d72020-07-23 17:32:15 -0700305 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion().String())
Colin Crossa97c5d32018-03-28 14:58:31 -0700306 }
307
308 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700309 var versionName string
310 if ctx.ModuleName() == "framework-res" {
311 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
312 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700313 // if it contains the build number. Use the PlatformVersionName instead.
314 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700315 } else {
316 versionName = ctx.Config().AppsDefaultVersionName()
317 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800318 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700319 linkFlags = append(linkFlags, "--version-name ", versionName)
320 }
321
Colin Crossa0ba2f52019-06-22 12:59:27 -0700322 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
323
324 // Always set --pseudo-localize, it will be stripped out later for release
325 // builds that don't want it.
326 compileFlags = append(compileFlags, "--pseudo-localize")
327
328 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700329}
330
Paul Duffin250e6192019-06-07 10:44:37 +0100331func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800332 if sdkDep.frameworkResModule != "" {
333 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700334 }
335}
336
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800337var extractAssetsRule = pctx.AndroidStaticRule("extractAssets",
338 blueprint.RuleParams{
339 Command: `${config.Zip2ZipCmd} -i ${in} -o ${out} "assets/**/*"`,
340 CommandDeps: []string{"${config.Zip2ZipCmd}"},
341 })
342
Alixf7a10272023-09-27 16:47:56 +0000343type aaptBuildActionOptions struct {
344 sdkContext android.SdkContext
345 classLoaderContexts dexpreopt.ClassLoaderContextMap
346 excludedLibs []string
347 enforceDefaultTargetSdkVersion bool
348 extraLinkFlags []string
Jihoon Kang84b25892023-12-01 22:01:06 +0000349 aconfigTextFiles android.Paths
Alixf7a10272023-09-27 16:47:56 +0000350}
351
352func (a *aapt) buildActions(ctx android.ModuleContext, opts aaptBuildActionOptions) {
Colin Cross5446e882019-05-22 10:46:27 -0700353
Colin Cross8676c8c2023-10-12 15:58:57 -0700354 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedExportPackages, libFlags :=
Alixf7a10272023-09-27 16:47:56 +0000355 aaptLibs(ctx, opts.sdkContext, opts.classLoaderContexts)
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100356
Paul Duffin06530572022-02-03 17:54:15 +0000357 // Exclude any libraries from the supplied list.
Alixf7a10272023-09-27 16:47:56 +0000358 opts.classLoaderContexts = opts.classLoaderContexts.ExcludeLibs(opts.excludedLibs)
Paul Duffin06530572022-02-03 17:54:15 +0000359
Colin Cross31656952018-05-24 16:11:20 -0700360 // App manifest file
361 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
362 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
363
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000364 manifestPath := ManifestFixer(ctx, manifestSrcPath, ManifestFixerParams{
Alixf7a10272023-09-27 16:47:56 +0000365 SdkContext: opts.sdkContext,
366 ClassLoaderContexts: opts.classLoaderContexts,
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000367 IsLibrary: a.isLibrary,
368 DefaultManifestVersion: a.defaultManifestVersion,
369 UseEmbeddedNativeLibs: a.useEmbeddedNativeLibs,
370 UsesNonSdkApis: a.usesNonSdkApis,
371 UseEmbeddedDex: a.useEmbeddedDex,
372 HasNoCode: a.hasNoCode,
373 LoggingParent: a.LoggingParent,
Alixf7a10272023-09-27 16:47:56 +0000374 EnforceDefaultTargetSdkVersion: opts.enforceDefaultTargetSdkVersion,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000375 })
Colin Cross90c25c62019-04-19 16:22:57 -0700376
Colin Crossab8d1382023-07-14 17:23:41 +0000377 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Cross8676c8c2023-10-12 15:58:57 -0700378 sharedDeps := transitiveAarDeps(sharedResourcesNodesDepSet.ToList())
Colin Crossab8d1382023-07-14 17:23:41 +0000379
Luca Stefanifd898822019-09-10 22:13:31 +0200380 // Add additional manifest files to transitive manifests.
381 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
Colin Crossab8d1382023-07-14 17:23:41 +0000382 transitiveManifestPaths := append(android.Paths{manifestPath}, additionalManifests...)
383 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
384 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
385 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
386 // android_library_import modules. If this is fixed, staticManifestsDepSet can be dropped completely in favor of
387 // staticResourcesNodesDepSet.manifests()
388 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700389
Colin Crossab8d1382023-07-14 17:23:41 +0000390 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000391 manifestMergerParams := ManifestMergerParams{
392 staticLibManifests: transitiveManifestPaths[1:],
Alix96ea88452023-08-31 15:48:23 +0000393 isLibrary: a.isLibrary,
394 packageName: a.manifestValues.applicationId,
395 }
Alixf7a10272023-09-27 16:47:56 +0000396 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Cross90c25c62019-04-19 16:22:57 -0700397 if !a.isLibrary {
398 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
399 // will be propagated to the final application and merged there. The merged manifest for libraries is
400 // only passed to Make, which can't handle transitive dependencies.
401 manifestPath = a.mergedManifestFile
402 }
403 } else {
404 a.mergedManifestFile = manifestPath
405 }
Colin Cross31656952018-05-24 16:11:20 -0700406
Alixf7a10272023-09-27 16:47:56 +0000407 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700408
409 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700410 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000411 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000412 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700413 if a.isLibrary {
414 linkFlags = append(linkFlags, "--static-lib")
415 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700416
Colin Cross4eae06d2023-06-20 22:40:02 -0700417 if a.isLibrary && a.useResourceProcessorBusyBox() {
418 // When building an android_library using ResourceProcessorBusyBox the resources are merged into
419 // package-res.apk with --merge-only, but --no-static-lib-packages is not used so that R.txt only
420 // contains resources from this library.
421 linkFlags = append(linkFlags, "--merge-only")
422 } else {
423 // When building and app or when building an android_library without ResourceProcessorBusyBox
424 // --no-static-lib-packages is used to put all the resources into the app. If ResourceProcessorBusyBox
425 // is used then the app's R.txt will be post-processed along with the R.txt files from dependencies to
426 // sort resources into the right packages in R.class.
427 linkFlags = append(linkFlags, "--no-static-lib-packages")
428 }
429
Colin Crossa97c5d32018-03-28 14:58:31 -0700430 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700431 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
432 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700433 // This file isn't used by Soong, but is generated for exporting
434 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700435 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700436 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700437
Colin Cross4aaa84a2018-08-21 15:14:37 -0700438 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700439 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700440 a.resourceFiles = append(a.resourceFiles, dir.files...)
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900441 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700442 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700443
Colin Crossa592e3e2019-02-19 16:59:53 -0800444 for i, zip := range resZips {
445 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700446 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800447 compiledResDirs = append(compiledResDirs, android.Paths{flata})
448 }
449
Colin Cross4aaa84a2018-08-21 15:14:37 -0700450 var compiledRes, compiledOverlay android.Paths
451
Colin Crossab8d1382023-07-14 17:23:41 +0000452 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
453 // of transitiveStaticLibs.
454 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
455
Colin Cross4eae06d2023-06-20 22:40:02 -0700456 if a.isLibrary && a.useResourceProcessorBusyBox() {
457 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
458 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
459 // instead modules depending on this module will reference package-res.apk from all transitive static
460 // dependencies.
461 for _, staticDep := range staticDeps {
462 linkDeps = append(linkDeps, staticDep.resPackage)
463 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
464 if staticDep.usedResourceProcessor {
465 transitiveRJars = append(transitiveRJars, staticDep.rJar)
466 }
467 }
Colin Cross8676c8c2023-10-12 15:58:57 -0700468 for _, sharedDep := range sharedDeps {
469 if sharedDep.usedResourceProcessor {
470 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
471 }
472 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700473 } else {
474 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
475 // dependencies are compiled into this module's package-res.apk as overlays.
476 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
477 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700478
Colin Crossbec85302019-02-13 13:15:46 -0800479 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700480 // If we are using static android libraries, every source file becomes an overlay.
481 // This is to emulate old AAPT behavior which simulated library support.
482 for _, compiledResDir := range compiledResDirs {
483 compiledOverlay = append(compiledOverlay, compiledResDir...)
484 }
Colin Crossbec85302019-02-13 13:15:46 -0800485 } else if a.isLibrary {
486 // Otherwise, for a static library we treat all the resources equally with no overlay.
487 for _, compiledResDir := range compiledResDirs {
488 compiledRes = append(compiledRes, compiledResDir...)
489 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700490 } else if len(compiledResDirs) > 0 {
491 // Without static libraries, the first directory is our directory, which can then be
492 // overlaid by the rest.
493 compiledRes = append(compiledRes, compiledResDirs[0]...)
494 for _, compiledResDir := range compiledResDirs[1:] {
495 compiledOverlay = append(compiledOverlay, compiledResDir...)
496 }
497 }
498
Colin Crossa97c5d32018-03-28 14:58:31 -0700499 for _, dir := range overlayDirs {
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900500 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700501 }
502
Colin Crosse560c4a2019-03-19 16:03:11 -0700503 var splitPackages android.WritablePaths
504 var splits []split
505
506 for _, s := range a.splitNames {
507 suffix := strings.Replace(s, ",", "_", -1)
508 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
509 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
510 splitPackages = append(splitPackages, path)
511 splits = append(splits, split{
512 name: s,
513 suffix: suffix,
514 path: path,
515 })
516 }
517
Colin Crossf3b7bad2023-08-02 15:49:00 -0700518 if !a.useResourceProcessorBusyBox() {
519 // the subdir "android" is required to be filtered by package names
520 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
521 }
522
Colin Crossab8d1382023-07-14 17:23:41 +0000523 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
524 // provided to the final app aapt2Link step.
525 var transitiveAssets android.Paths
526 if !a.isLibrary {
527 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
528 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700529 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000530 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
531 opts.aconfigTextFiles)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800532 // Extract assets from the resource package output so that they can be used later in aapt2link
533 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000534 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800535 assets := android.PathForModuleOut(ctx, "assets.zip")
536 ctx.Build(pctx, android.BuildParams{
537 Rule: extractAssetsRule,
538 Input: packageRes,
539 Output: assets,
540 Description: "extract assets from built resource file",
541 })
542 a.assetPackage = android.OptionalPathForPath(assets)
543 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700544
Colin Cross4eae06d2023-06-20 22:40:02 -0700545 if a.useResourceProcessorBusyBox() {
546 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
547 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700548 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700549 transitiveRJars = append(transitiveRJars, rJar)
550 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700551 } else {
552 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700553 }
554
Colin Cross312634e2023-11-21 15:13:56 -0800555 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
556 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
557 return p == packageRes.String()
558 })
559 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
560 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
561
Colin Crossa97c5d32018-03-28 14:58:31 -0700562 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700563 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800564 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700565 a.exportPackage = packageRes
566 a.manifestPath = manifestPath
567 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700568 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700569 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700570 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000571 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
572 Direct(&resourcesNode{
573 resPackage: a.exportPackage,
574 manifest: a.manifestPath,
575 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700576 rTxt: a.rTxt,
577 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000578 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700579
580 usedResourceProcessor: a.useResourceProcessorBusyBox(),
Colin Crossab8d1382023-07-14 17:23:41 +0000581 }).
582 Transitive(staticResourcesNodesDepSet).Build()
583 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
584 Direct(rroDirs...).
585 Transitive(staticRRODirsDepSet).Build()
586 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
587 Direct(a.manifestPath).
588 DirectSlice(additionalManifests).
589 Transitive(staticManifestsDepSet).Build()
590}
591
Colin Cross4eae06d2023-06-20 22:40:02 -0700592var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
593 blueprint.RuleParams{
594 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
595 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
596 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
597 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
598 Rspfile: "${out}.args",
599 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
600 Restat: true,
601 }, "rTxt", "manifest", "args")
602
603// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
604// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
605// supports producing classes for static dependencies that only include resources from that dependency.
606func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
607 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool) {
608
609 var args []string
610 var deps android.Paths
611
612 if !isLibrary {
613 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
614 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
615 // package.
616 args, deps = transitiveDeps.resourceProcessorDeps()
617 } else {
618 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
619 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
620 // inlined into the library before the final IDs are assigned during app compilation.
621 args = append(args, "--finalFields=false")
622 }
623
624 deps = append(deps, rTxt, manifest)
625
626 ctx.Build(pctx, android.BuildParams{
627 Rule: resourceProcessorBusyBox,
628 Output: rJar,
629 Implicits: deps,
630 Description: "ResourceProcessorBusyBox",
631 Args: map[string]string{
632 "rTxt": rTxt.String(),
633 "manifest": manifest.String(),
634 "args": strings.Join(args, " "),
635 },
636 })
637}
638
Colin Crossab8d1382023-07-14 17:23:41 +0000639type resourcesNode struct {
640 resPackage android.Path
641 manifest android.Path
642 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700643 rTxt android.Path
644 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000645 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700646
647 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000648}
649
650type transitiveAarDeps []*resourcesNode
651
652func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700653 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000654 for _, dep := range t {
655 paths = append(paths, dep.resPackage)
656 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700657 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000658}
659
660func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700661 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000662 for _, dep := range t {
663 paths = append(paths, dep.manifest)
664 paths = append(paths, dep.additionalManifests...)
665 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700666 return paths
667}
668
669func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
670 for _, dep := range t {
671 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
672 deps = append(deps, dep.rTxt, dep.manifest)
673 }
674 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000675}
676
677func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700678 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000679 for _, dep := range t {
680 if dep.assets.Valid() {
681 paths = append(paths, dep.assets.Path())
682 }
683 }
684 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700685}
686
687// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900688func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700689 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000690 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700691
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100692 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000693 // Not all callers need to compute class loader context, those who don't just pass nil.
694 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100695 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000696 }
697
Colin Cross83bb3162018-06-25 15:48:06 -0700698 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700699 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700700 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700701 }
702
Colin Cross8676c8c2023-10-12 15:58:57 -0700703 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
704 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000705 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
706 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
707
Colin Crossa97c5d32018-03-28 14:58:31 -0700708 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000709 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000710
Colin Crossa97c5d32018-03-28 14:58:31 -0700711 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700712 aarDep, _ := module.(AndroidLibraryDependency)
713 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700714 exportPackage = aarDep.ExportPackage()
715 }
716
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000717 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700718 case instrumentationForTag:
719 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400720 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700721 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700722 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700723 sharedLibs = append(sharedLibs, exportPackage)
724 }
Colin Cross5446e882019-05-22 10:46:27 -0700725 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700726 if exportPackage != nil {
727 sharedLibs = append(sharedLibs, exportPackage)
728 }
729 case staticLibTag:
730 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700731 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000732 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
733 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700734 }
735 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000736
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000737 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700738 })
739
Colin Crossab8d1382023-07-14 17:23:41 +0000740 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
741 // Reverse the dependency order now going into the depset so that it comes out in order after the second
742 // reverse later.
743 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
744 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
745 // dependency has to be listed last.
746 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700747 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
748 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
749 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700750
Colin Crossab8d1382023-07-14 17:23:41 +0000751 staticRRODirs = rroDirsDepSetBuilder.Build()
752 staticManifests = manifestsDepSetBuilder.Build()
753
754 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700755 flags = append(flags, "--auto-add-overlay")
756 }
757
758 for _, sharedLib := range sharedLibs {
759 flags = append(flags, "-I "+sharedLib.String())
760 }
761
Colin Cross8676c8c2023-10-12 15:58:57 -0700762 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700763}
764
765type AndroidLibrary struct {
766 Library
767 aapt
768
769 androidLibraryProperties androidLibraryProperties
770
771 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700772}
773
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000774var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
775
776// For OutputFileProducer interface
777func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
778 switch tag {
779 case ".aar":
780 return []android.Path{a.aarFile}, nil
781 default:
782 return a.Library.OutputFiles(tag)
783 }
784}
785
Colin Crossa97c5d32018-03-28 14:58:31 -0700786var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
787
788func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
789 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900790 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100791 if sdkDep.hasFrameworkLibs() {
792 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700793 }
Colin Cross4a80a152022-12-21 21:51:52 -0800794 a.usesLibrary.deps(ctx, false)
Colin Crossa97c5d32018-03-28 14:58:31 -0700795}
796
797func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800798 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100799 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Alixf7a10272023-09-27 16:47:56 +0000800 a.aapt.buildActions(ctx,
801 aaptBuildActionOptions{
802 sdkContext: android.SdkContext(a),
803 classLoaderContexts: a.classLoaderContexts,
804 enforceDefaultTargetSdkVersion: false,
805 },
806 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700807
Colin Crossff694a82023-12-13 15:54:49 -0800808 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
809 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700810
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000811 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
812
Colin Cross4eae06d2023-06-20 22:40:02 -0700813 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
814 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross4eae06d2023-06-20 22:40:02 -0700815 if a.useResourceProcessorBusyBox() {
816 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700817 } else {
818 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700819 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700820
821 // apps manifests are handled by aapt, don't let Module see them
822 a.properties.Manifest = nil
823
Colin Cross014489c2020-06-02 20:09:13 -0700824 a.linter.mergedManifest = a.aapt.mergedManifestFile
825 a.linter.manifest = a.aapt.manifestPath
826 a.linter.resources = a.aapt.resourceFiles
827
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000828 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800829 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800830 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
831 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
832 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
833
834 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
835 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
836 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700837
Colin Cross4eae06d2023-06-20 22:40:02 -0700838 var extraSrcJars android.Paths
839 var extraCombinedJars android.Paths
840 var extraClasspathJars android.Paths
841 if a.useResourceProcessorBusyBox() {
842 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
843 // library and each of the transitive static android_library dependencies has already created an
844 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
845 extraClasspathJars = a.transitiveAaptRJars
846 } else {
847 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
848 // R.java files for the library's package and the packages from all transitive static android_library
849 // dependencies. Compile the srcjar alongside the rest of the sources.
850 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
851 }
852
853 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700854
Colin Crossf57c5782019-01-25 13:20:38 -0800855 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700856 var res android.Paths
857 if a.androidLibraryProperties.BuildAAR {
858 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
859 ctx.CheckbuildFile(a.aarFile)
860 }
Colin Cross89c31582018-04-30 15:55:11 -0700861
Sam Delmerico82602492022-06-10 17:05:42 +0000862 prebuiltJniPackages := android.Paths{}
863 ctx.VisitDirectDeps(func(module android.Module) {
864 if info, ok := ctx.OtherModuleProvider(module, JniPackageProvider).(JniPackageInfo); ok {
865 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
866 }
867 })
868 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800869 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000870 JniPackages: prebuiltJniPackages,
871 })
872 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700873}
874
Colin Cross95b53b82023-10-17 13:21:02 -0700875func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
876 a.Library.IDEInfo(dpInfo)
877 a.aapt.IDEInfo(dpInfo)
878}
879
880func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
881 if a.useResourceProcessorBusyBox() {
882 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
883 }
884}
885
Colin Cross1b16b0e2019-02-12 14:41:32 -0800886// android_library builds and links sources into a `.jar` file for the device along with Android resources.
887//
888// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000889// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800890// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
891// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700892func AndroidLibraryFactory() android.Module {
893 module := &AndroidLibrary{}
894
Colin Crossce6734e2020-06-15 16:09:53 -0700895 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700896 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700897 &module.aaptProperties,
898 &module.androidLibraryProperties)
899
900 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700901 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700902
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900903 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700904 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700905 return module
906}
907
Colin Crossfabb6082018-02-20 17:22:23 -0800908//
909// AAR (android library) prebuilts
910//
Colin Crossfabb6082018-02-20 17:22:23 -0800911
Vinh Trance0781f2022-04-13 01:30:44 +0000912// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800913type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000914 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800915 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000916 // If not blank, set to the version of the sdk to compile against.
917 // Defaults to private.
918 // Values are of one of the following forms:
919 // 1) numerical API level, "current", "none", or "core_platform"
920 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
921 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
922 // If the SDK kind is empty, it will be set to public
923 Sdk_version *string
924 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
925 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700926 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000927 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700928 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000929 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
930 Libs []string
931 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700932 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000933 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
934 // will be passed transitively through android_libraries to an android_app.
935 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
936 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800937}
938
939type AARImport struct {
940 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700941 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900942 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800943 prebuilt android.Prebuilt
944
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900945 // Functionality common to Module and Import.
946 embeddableInModuleAndImport
947
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500948 providesTransitiveHeaderJars
949
Colin Crossfabb6082018-02-20 17:22:23 -0800950 properties AARImportProperties
951
Colin Cross312634e2023-11-21 15:13:56 -0800952 classpathFile android.WritablePath
953 proguardFlags android.WritablePath
954 exportPackage android.WritablePath
955 transitiveAaptResourcePackagesFile android.Path
956 extraAaptPackagesFile android.WritablePath
957 manifest android.WritablePath
958 assetsPackage android.WritablePath
959 rTxt android.WritablePath
960 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700961
Colin Crossab8d1382023-07-14 17:23:41 +0000962 resourcesNodesDepSet *android.DepSet[*resourcesNode]
963 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700964
965 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000966
Sam Delmerico82602492022-06-10 17:05:42 +0000967 aarPath android.Path
968 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900969
970 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000971 minSdkVersion android.ApiLevel
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000972}
973
974var _ android.OutputFileProducer = (*AARImport)(nil)
975
976// For OutputFileProducer interface
977func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
978 switch tag {
979 case ".aar":
980 return []android.Path{a.aarPath}, nil
981 case "":
982 return []android.Path{a.classpathFile}, nil
983 default:
984 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
985 }
Colin Crossfabb6082018-02-20 17:22:23 -0800986}
987
Jiyong Park92315372021-04-02 08:45:46 +0900988func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
989 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700990}
991
Jiyong Parkf1691d22021-03-29 20:11:58 +0900992func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +0100993 return ""
994}
995
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000996func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -0700997 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000998 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -0700999 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001000 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001001}
1002
Spandan Dasa26eda72023-03-02 00:56:06 +00001003func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1004 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001005}
1006
Spandan Dasca70fc42023-03-01 23:38:49 +00001007func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1008 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001009}
1010
Colin Cross1e743852019-10-28 11:37:20 -07001011func (a *AARImport) javaVersion() string {
1012 return ""
1013}
1014
Colin Crossa97c5d32018-03-28 14:58:31 -07001015var _ AndroidLibraryDependency = (*AARImport)(nil)
1016
1017func (a *AARImport) ExportPackage() android.Path {
1018 return a.exportPackage
1019}
Colin Crossab8d1382023-07-14 17:23:41 +00001020func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1021 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001022}
1023
Colin Crossab8d1382023-07-14 17:23:41 +00001024func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1025 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001026}
1027
Colin Crossab8d1382023-07-14 17:23:41 +00001028func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1029 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001030}
1031
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001032// RRO enforcement is not available on aar_import since its RRO dirs are not
1033// exported.
1034func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1035}
1036
1037// RRO enforcement is not available on aar_import since its RRO dirs are not
1038// exported.
1039func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1040 return false
1041}
1042
Colin Crossfabb6082018-02-20 17:22:23 -08001043func (a *AARImport) Prebuilt() *android.Prebuilt {
1044 return &a.prebuilt
1045}
1046
1047func (a *AARImport) Name() string {
1048 return a.prebuilt.Name(a.ModuleBase.Name())
1049}
1050
Jiyong Park618922e2020-01-08 13:35:43 +09001051func (a *AARImport) JacocoReportClassesFile() android.Path {
1052 return nil
1053}
1054
Colin Crossfabb6082018-02-20 17:22:23 -08001055func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001056 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001057 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001058 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001059 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001060 }
1061 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001062
Colin Cross42d48b72018-08-29 14:10:52 -07001063 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1064 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -08001065}
1066
Sam Delmerico82602492022-06-10 17:05:42 +00001067type JniPackageInfo struct {
1068 // List of zip files containing JNI libraries
1069 // Zip files should have directory structure jni/<arch>/*.so
1070 JniPackages android.Paths
1071}
1072
Colin Crossbc7d76c2023-12-12 16:39:03 -08001073var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001074
1075// Unzip an AAR and extract the JNI libs for $archString.
1076var extractJNI = pctx.AndroidStaticRule("extractJNI",
1077 blueprint.RuleParams{
1078 Command: `rm -rf $out $outDir && touch $out && ` +
1079 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1080 `jni_files=$$(find $outDir/jni -type f) && ` +
1081 // print error message if there are no JNI libs for this arch
1082 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001083 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001084 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1085 CommandDeps: []string{"${config.SoongZipCmd}"},
1086 },
1087 "outDir", "archString")
1088
Colin Crossfabb6082018-02-20 17:22:23 -08001089// Unzip an AAR into its constituent files and directories. Any files in Outputs that don't exist in the AAR will be
Dan Willemsen304cfec2019-05-28 14:49:06 -07001090// touched to create an empty file. The res directory is not extracted, as it will be extracted in its own rule.
Colin Crossfabb6082018-02-20 17:22:23 -08001091var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1092 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001093 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001094 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001095 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001096 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001097 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001098 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001099 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001100
1101func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1102 if len(a.properties.Aars) != 1 {
1103 ctx.PropertyErrorf("aars", "exactly one aar is required")
1104 return
1105 }
1106
Jiyong Park92315372021-04-02 08:45:46 +09001107 a.sdkVersion = a.SdkVersion(ctx)
1108 a.minSdkVersion = a.MinSdkVersion(ctx)
1109
Colin Crossff694a82023-12-13 15:54:49 -08001110 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1111 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001112
Nan Zhang4c819fb2018-08-27 18:31:46 -07001113 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001114 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1115
Colin Cross1001a792019-03-21 22:21:39 -07001116 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001117 inputFile := a.aarPath
1118 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1119 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001120 }
Colin Crossfabb6082018-02-20 17:22:23 -08001121
1122 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross205e9112020-08-06 13:20:17 -07001123 a.classpathFile = extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001124 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Cross4eae06d2023-06-20 22:40:02 -07001125 aarRTxt := extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001126 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001127 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross40213022023-12-13 15:19:49 -08001128 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001129 ProguardFlagsFiles: android.NewDepSet[android.Path](
1130 android.POSTORDER,
1131 android.Paths{a.proguardFlags},
1132 nil,
1133 ),
1134 })
Colin Crossfabb6082018-02-20 17:22:23 -08001135
1136 ctx.Build(pctx, android.BuildParams{
1137 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001138 Input: a.aarPath,
Colin Cross4eae06d2023-06-20 22:40:02 -07001139 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, aarRTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001140 Description: "unzip AAR",
1141 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001142 "outDir": extractedAARDir.String(),
1143 "combinedClassesJar": a.classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001144 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001145 },
1146 })
1147
Colin Crossa0ba2f52019-06-22 12:59:27 -07001148 // Always set --pseudo-localize, it will be stripped out later for release
1149 // builds that don't want it.
1150 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001151 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001152 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001153 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001154
1155 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001156 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Cross4eae06d2023-06-20 22:40:02 -07001157 a.rTxt = android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001158 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001159
1160 var linkDeps android.Paths
1161
1162 linkFlags := []string{
1163 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001164 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001165 "--auto-add-overlay",
1166 }
1167
Colin Cross10f7c4a2018-05-23 10:59:28 -07001168 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1169 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001170
Colin Cross8676c8c2023-10-12 15:58:57 -07001171 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001172 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001173
Colin Cross8676c8c2023-10-12 15:58:57 -07001174 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001175 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001176
Colin Crossab8d1382023-07-14 17:23:41 +00001177 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001178
Colin Crossab8d1382023-07-14 17:23:41 +00001179 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001180 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001181 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001182
Colin Cross4eae06d2023-06-20 22:40:02 -07001183 overlayRes := android.Paths{flata}
1184
1185 // Treat static library dependencies of static libraries as imports.
1186 transitiveStaticLibs := staticDeps.resPackages()
1187 linkDeps = append(linkDeps, transitiveStaticLibs...)
1188 for _, staticLib := range transitiveStaticLibs {
1189 linkFlags = append(linkFlags, "-I "+staticLib.String())
1190 }
Colin Crossfabb6082018-02-20 17:22:23 -08001191
Colin Crossab8d1382023-07-14 17:23:41 +00001192 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossf3b7bad2023-08-02 15:49:00 -07001193 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, a.rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001194 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001195
Colin Cross4eae06d2023-06-20 22:40:02 -07001196 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
1197 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true)
1198
Colin Crossf3b7bad2023-08-02 15:49:00 -07001199 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1200
Colin Crossab8d1382023-07-14 17:23:41 +00001201 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1202 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1203 resPackage: a.exportPackage,
1204 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001205 rTxt: a.rTxt,
1206 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001207 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001208
1209 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001210 })
1211 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1212 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1213
1214 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
1215 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
1216 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
1217 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
1218 // android_library_import modules. If this is fixed, AndroidLibraryDependency.ManifestsDepSet can be dropped
1219 // completely in favor of AndroidLibraryDependency.ResourceNodesDepSet.manifest
1220 //manifestDepSetBuilder.Transitive(transitiveStaticDeps.manifests)
1221 _ = staticManifestsDepSet
1222 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001223
Colin Cross312634e2023-11-21 15:13:56 -08001224 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1225 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1226 return p == a.exportPackage.String()
1227 })
1228 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1229 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1230 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001231
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001232 a.collectTransitiveHeaderJars(ctx)
Colin Cross40213022023-12-13 15:19:49 -08001233 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Colin Crossdcf71b22021-02-01 13:59:03 -08001234 HeaderJars: android.PathsIfNonNil(a.classpathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001235 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1236 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08001237 ImplementationAndResourcesJars: android.PathsIfNonNil(a.classpathFile),
1238 ImplementationJars: android.PathsIfNonNil(a.classpathFile),
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001239 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001240 })
Sam Delmerico82602492022-06-10 17:05:42 +00001241
1242 if proptools.Bool(a.properties.Extract_jni) {
1243 for _, t := range ctx.MultiTargets() {
1244 arch := t.Arch.Abi[0]
1245 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1246 a.jniPackages = append(a.jniPackages, path)
1247
1248 outDir := android.PathForModuleOut(ctx, "aarForJni")
1249 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1250 ctx.Build(pctx, android.BuildParams{
1251 Rule: extractJNI,
1252 Input: aarPath,
1253 Outputs: android.WritablePaths{path},
1254 Description: "extract JNI from AAR",
1255 Args: map[string]string{
1256 "outDir": outDir.String(),
1257 "archString": arch,
1258 },
1259 })
1260 }
Sam Delmerico82602492022-06-10 17:05:42 +00001261 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001262
Colin Cross40213022023-12-13 15:19:49 -08001263 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001264 JniPackages: a.jniPackages,
1265 })
Colin Crossdcf71b22021-02-01 13:59:03 -08001266}
Colin Crossfabb6082018-02-20 17:22:23 -08001267
1268func (a *AARImport) HeaderJars() android.Paths {
1269 return android.Paths{a.classpathFile}
1270}
1271
Colin Cross331a1212018-08-15 20:40:52 -07001272func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
1273 return android.Paths{a.classpathFile}
1274}
1275
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00001276func (a *AARImport) DexJarBuildPath() android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001277 return nil
1278}
1279
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001280func (a *AARImport) DexJarInstallPath() android.Path {
1281 return nil
1282}
1283
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001284func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Jiyong Park1be96912018-05-28 18:02:19 +09001285 return nil
1286}
1287
Jiyong Park45bf82e2020-12-15 22:29:02 +09001288var _ android.ApexModule = (*AARImport)(nil)
1289
1290// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001291func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1292 return a.depIsInSameApex(ctx, dep)
1293}
1294
Jiyong Park45bf82e2020-12-15 22:29:02 +09001295// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07001296func (g *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
1297 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001298 return nil
1299}
1300
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001301var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001302
Colin Cross1b16b0e2019-02-12 14:41:32 -08001303// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1304//
1305// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1306// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001307func AARImportFactory() android.Module {
1308 module := &AARImport{}
1309
1310 module.AddProperties(&module.properties)
1311
1312 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001313 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001314 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001315 return module
1316}