blob: 7dcf1d1551481ee8030dda9faaa5f6bd77ead608 [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) {
Colin Cross7e6a9012024-01-17 14:58:38 -080047 ctx.TopDown("propagate_rro_enforcement", propagateRROEnforcementMutator)
Paul Duffin04ba70d2021-03-22 13:56:43 +000048 })
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 Cross8f1b0332024-01-25 13:39:06 -0800162func (a *aapt) useResourceProcessorBusyBox(ctx android.BaseModuleContext) bool {
163 return BoolDefault(a.aaptProperties.Use_resource_processor, ctx.Config().UseResourceProcessorByDefault())
Colin Cross4eae06d2023-06-20 22:40:02 -0700164}
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 Cross7c4dc5d2024-02-13 14:29:45 -0800417 linkFlags = append(linkFlags, "--no-static-lib-packages")
Colin Cross8f1b0332024-01-25 13:39:06 -0800418 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800419 // When building an android_library using ResourceProcessorBusyBox pass --merge-only to skip resource
420 // references validation until the final app link step when all static libraries are present.
Colin Cross4eae06d2023-06-20 22:40:02 -0700421 linkFlags = append(linkFlags, "--merge-only")
Colin Cross4eae06d2023-06-20 22:40:02 -0700422 }
423
Colin Crossa97c5d32018-03-28 14:58:31 -0700424 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700425 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
426 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700427 // This file isn't used by Soong, but is generated for exporting
428 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700429 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700430 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700431
Colin Cross4aaa84a2018-08-21 15:14:37 -0700432 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700433 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700434 a.resourceFiles = append(a.resourceFiles, dir.files...)
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900435 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700436 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700437
Colin Crossa592e3e2019-02-19 16:59:53 -0800438 for i, zip := range resZips {
439 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700440 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800441 compiledResDirs = append(compiledResDirs, android.Paths{flata})
442 }
443
Colin Cross4aaa84a2018-08-21 15:14:37 -0700444 var compiledRes, compiledOverlay android.Paths
445
Colin Crossab8d1382023-07-14 17:23:41 +0000446 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
447 // of transitiveStaticLibs.
448 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
449
Colin Cross8f1b0332024-01-25 13:39:06 -0800450 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700451 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
452 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
453 // instead modules depending on this module will reference package-res.apk from all transitive static
454 // dependencies.
455 for _, staticDep := range staticDeps {
456 linkDeps = append(linkDeps, staticDep.resPackage)
457 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
458 if staticDep.usedResourceProcessor {
459 transitiveRJars = append(transitiveRJars, staticDep.rJar)
460 }
461 }
Colin Cross8676c8c2023-10-12 15:58:57 -0700462 for _, sharedDep := range sharedDeps {
463 if sharedDep.usedResourceProcessor {
464 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
465 }
466 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700467 } else {
468 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
469 // dependencies are compiled into this module's package-res.apk as overlays.
470 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
471 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700472
Colin Crossbec85302019-02-13 13:15:46 -0800473 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700474 // If we are using static android libraries, every source file becomes an overlay.
475 // This is to emulate old AAPT behavior which simulated library support.
476 for _, compiledResDir := range compiledResDirs {
477 compiledOverlay = append(compiledOverlay, compiledResDir...)
478 }
Colin Crossbec85302019-02-13 13:15:46 -0800479 } else if a.isLibrary {
480 // Otherwise, for a static library we treat all the resources equally with no overlay.
481 for _, compiledResDir := range compiledResDirs {
482 compiledRes = append(compiledRes, compiledResDir...)
483 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700484 } else if len(compiledResDirs) > 0 {
485 // Without static libraries, the first directory is our directory, which can then be
486 // overlaid by the rest.
487 compiledRes = append(compiledRes, compiledResDirs[0]...)
488 for _, compiledResDir := range compiledResDirs[1:] {
489 compiledOverlay = append(compiledOverlay, compiledResDir...)
490 }
491 }
492
Colin Crossa97c5d32018-03-28 14:58:31 -0700493 for _, dir := range overlayDirs {
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900494 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700495 }
496
Colin Crosse560c4a2019-03-19 16:03:11 -0700497 var splitPackages android.WritablePaths
498 var splits []split
499
500 for _, s := range a.splitNames {
501 suffix := strings.Replace(s, ",", "_", -1)
502 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
503 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
504 splitPackages = append(splitPackages, path)
505 splits = append(splits, split{
506 name: s,
507 suffix: suffix,
508 path: path,
509 })
510 }
511
Colin Cross8f1b0332024-01-25 13:39:06 -0800512 if !a.useResourceProcessorBusyBox(ctx) {
Colin Crossf3b7bad2023-08-02 15:49:00 -0700513 // the subdir "android" is required to be filtered by package names
514 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
515 }
516
Colin Crossab8d1382023-07-14 17:23:41 +0000517 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
518 // provided to the final app aapt2Link step.
519 var transitiveAssets android.Paths
520 if !a.isLibrary {
521 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
522 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700523 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000524 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
525 opts.aconfigTextFiles)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800526 // Extract assets from the resource package output so that they can be used later in aapt2link
527 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000528 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800529 assets := android.PathForModuleOut(ctx, "assets.zip")
530 ctx.Build(pctx, android.BuildParams{
531 Rule: extractAssetsRule,
532 Input: packageRes,
533 Output: assets,
534 Description: "extract assets from built resource file",
535 })
536 a.assetPackage = android.OptionalPathForPath(assets)
537 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700538
Colin Cross8f1b0332024-01-25 13:39:06 -0800539 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700540 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800541 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary, a.aaptProperties.Aaptflags)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700542 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700543 transitiveRJars = append(transitiveRJars, rJar)
544 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700545 } else {
546 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700547 }
548
Colin Cross312634e2023-11-21 15:13:56 -0800549 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
550 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
551 return p == packageRes.String()
552 })
553 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
554 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
555
Colin Crossa97c5d32018-03-28 14:58:31 -0700556 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700557 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800558 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700559 a.exportPackage = packageRes
560 a.manifestPath = manifestPath
561 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700562 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700563 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700564 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000565 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
566 Direct(&resourcesNode{
567 resPackage: a.exportPackage,
568 manifest: a.manifestPath,
569 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700570 rTxt: a.rTxt,
571 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000572 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700573
Colin Cross8f1b0332024-01-25 13:39:06 -0800574 usedResourceProcessor: a.useResourceProcessorBusyBox(ctx),
Colin Crossab8d1382023-07-14 17:23:41 +0000575 }).
576 Transitive(staticResourcesNodesDepSet).Build()
577 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
578 Direct(rroDirs...).
579 Transitive(staticRRODirsDepSet).Build()
580 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
581 Direct(a.manifestPath).
582 DirectSlice(additionalManifests).
583 Transitive(staticManifestsDepSet).Build()
584}
585
Colin Cross4eae06d2023-06-20 22:40:02 -0700586var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
587 blueprint.RuleParams{
588 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
589 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
590 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
591 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
592 Rspfile: "${out}.args",
593 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
594 Restat: true,
595 }, "rTxt", "manifest", "args")
596
597// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
598// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
599// supports producing classes for static dependencies that only include resources from that dependency.
600func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800601 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool, aaptFlags []string) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700602
603 var args []string
604 var deps android.Paths
605
606 if !isLibrary {
607 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
608 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
609 // package.
610 args, deps = transitiveDeps.resourceProcessorDeps()
611 } else {
612 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
613 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
614 // inlined into the library before the final IDs are assigned during app compilation.
615 args = append(args, "--finalFields=false")
616 }
617
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800618 for i, arg := range aaptFlags {
619 const AAPT_CUSTOM_PACKAGE = "--custom-package"
620 if strings.HasPrefix(arg, AAPT_CUSTOM_PACKAGE) {
621 pkg := strings.TrimSpace(strings.TrimPrefix(arg, AAPT_CUSTOM_PACKAGE))
622 if pkg == "" && i+1 < len(aaptFlags) {
623 pkg = aaptFlags[i+1]
624 }
625 args = append(args, "--packageForR "+pkg)
626 }
627 }
628
Colin Cross4eae06d2023-06-20 22:40:02 -0700629 deps = append(deps, rTxt, manifest)
630
631 ctx.Build(pctx, android.BuildParams{
632 Rule: resourceProcessorBusyBox,
633 Output: rJar,
634 Implicits: deps,
635 Description: "ResourceProcessorBusyBox",
636 Args: map[string]string{
637 "rTxt": rTxt.String(),
638 "manifest": manifest.String(),
639 "args": strings.Join(args, " "),
640 },
641 })
642}
643
Colin Crossab8d1382023-07-14 17:23:41 +0000644type resourcesNode struct {
645 resPackage android.Path
646 manifest android.Path
647 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700648 rTxt android.Path
649 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000650 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700651
652 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000653}
654
655type transitiveAarDeps []*resourcesNode
656
657func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700658 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000659 for _, dep := range t {
660 paths = append(paths, dep.resPackage)
661 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700662 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000663}
664
665func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700666 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000667 for _, dep := range t {
668 paths = append(paths, dep.manifest)
669 paths = append(paths, dep.additionalManifests...)
670 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700671 return paths
672}
673
674func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
675 for _, dep := range t {
676 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
677 deps = append(deps, dep.rTxt, dep.manifest)
678 }
679 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000680}
681
682func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700683 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000684 for _, dep := range t {
685 if dep.assets.Valid() {
686 paths = append(paths, dep.assets.Path())
687 }
688 }
689 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700690}
691
692// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900693func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700694 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000695 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700696
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100697 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000698 // Not all callers need to compute class loader context, those who don't just pass nil.
699 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100700 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000701 }
702
Colin Cross83bb3162018-06-25 15:48:06 -0700703 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700704 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700705 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700706 }
707
Colin Cross8676c8c2023-10-12 15:58:57 -0700708 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
709 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000710 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
711 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
712
Colin Crossa97c5d32018-03-28 14:58:31 -0700713 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000714 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000715
Colin Crossa97c5d32018-03-28 14:58:31 -0700716 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700717 aarDep, _ := module.(AndroidLibraryDependency)
718 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700719 exportPackage = aarDep.ExportPackage()
720 }
721
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000722 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700723 case instrumentationForTag:
724 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400725 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700726 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700727 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700728 sharedLibs = append(sharedLibs, exportPackage)
729 }
Colin Cross5446e882019-05-22 10:46:27 -0700730 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700731 if exportPackage != nil {
732 sharedLibs = append(sharedLibs, exportPackage)
733 }
734 case staticLibTag:
735 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700736 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000737 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
738 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700739 }
740 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000741
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000742 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700743 })
744
Colin Crossab8d1382023-07-14 17:23:41 +0000745 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
746 // Reverse the dependency order now going into the depset so that it comes out in order after the second
747 // reverse later.
748 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
749 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
750 // dependency has to be listed last.
751 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700752 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
753 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
754 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700755
Colin Crossab8d1382023-07-14 17:23:41 +0000756 staticRRODirs = rroDirsDepSetBuilder.Build()
757 staticManifests = manifestsDepSetBuilder.Build()
758
759 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700760 flags = append(flags, "--auto-add-overlay")
761 }
762
763 for _, sharedLib := range sharedLibs {
764 flags = append(flags, "-I "+sharedLib.String())
765 }
766
Colin Cross8676c8c2023-10-12 15:58:57 -0700767 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700768}
769
770type AndroidLibrary struct {
771 Library
772 aapt
773
774 androidLibraryProperties androidLibraryProperties
775
776 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700777}
778
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000779var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
780
781// For OutputFileProducer interface
782func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
783 switch tag {
784 case ".aar":
785 return []android.Path{a.aarFile}, nil
786 default:
787 return a.Library.OutputFiles(tag)
788 }
789}
790
Colin Crossa97c5d32018-03-28 14:58:31 -0700791var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
792
793func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
794 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900795 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100796 if sdkDep.hasFrameworkLibs() {
797 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700798 }
Colin Cross4a80a152022-12-21 21:51:52 -0800799 a.usesLibrary.deps(ctx, false)
Colin Crossa97c5d32018-03-28 14:58:31 -0700800}
801
802func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800803 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100804 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Alixf7a10272023-09-27 16:47:56 +0000805 a.aapt.buildActions(ctx,
806 aaptBuildActionOptions{
807 sdkContext: android.SdkContext(a),
808 classLoaderContexts: a.classLoaderContexts,
809 enforceDefaultTargetSdkVersion: false,
810 },
811 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700812
Colin Crossff694a82023-12-13 15:54:49 -0800813 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
814 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700815
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000816 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
817
Colin Cross4eae06d2023-06-20 22:40:02 -0700818 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
819 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross8f1b0332024-01-25 13:39:06 -0800820 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700821 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700822 } else {
823 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700824 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700825
826 // apps manifests are handled by aapt, don't let Module see them
827 a.properties.Manifest = nil
828
Colin Cross014489c2020-06-02 20:09:13 -0700829 a.linter.mergedManifest = a.aapt.mergedManifestFile
830 a.linter.manifest = a.aapt.manifestPath
831 a.linter.resources = a.aapt.resourceFiles
832
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000833 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800834 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800835 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
836 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
837 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
838
839 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
840 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
841 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700842
Colin Cross4eae06d2023-06-20 22:40:02 -0700843 var extraSrcJars android.Paths
844 var extraCombinedJars android.Paths
845 var extraClasspathJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800846 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700847 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
848 // library and each of the transitive static android_library dependencies has already created an
849 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
850 extraClasspathJars = a.transitiveAaptRJars
851 } else {
852 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
853 // R.java files for the library's package and the packages from all transitive static android_library
854 // dependencies. Compile the srcjar alongside the rest of the sources.
855 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
856 }
857
858 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700859
Colin Crossf57c5782019-01-25 13:20:38 -0800860 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700861 var res android.Paths
862 if a.androidLibraryProperties.BuildAAR {
863 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
864 ctx.CheckbuildFile(a.aarFile)
865 }
Colin Cross89c31582018-04-30 15:55:11 -0700866
Sam Delmerico82602492022-06-10 17:05:42 +0000867 prebuiltJniPackages := android.Paths{}
868 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800869 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000870 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
871 }
872 })
873 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800874 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000875 JniPackages: prebuiltJniPackages,
876 })
877 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700878}
879
Colin Cross95b53b82023-10-17 13:21:02 -0700880func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
881 a.Library.IDEInfo(dpInfo)
882 a.aapt.IDEInfo(dpInfo)
883}
884
885func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
Colin Cross8f1b0332024-01-25 13:39:06 -0800886 if a.rJar != nil {
Colin Cross95b53b82023-10-17 13:21:02 -0700887 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
888 }
889}
890
Colin Cross1b16b0e2019-02-12 14:41:32 -0800891// android_library builds and links sources into a `.jar` file for the device along with Android resources.
892//
893// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000894// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800895// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
896// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700897func AndroidLibraryFactory() android.Module {
898 module := &AndroidLibrary{}
899
Colin Crossce6734e2020-06-15 16:09:53 -0700900 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700901 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700902 &module.aaptProperties,
903 &module.androidLibraryProperties)
904
905 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700906 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700907
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900908 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700909 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700910 return module
911}
912
Colin Crossfabb6082018-02-20 17:22:23 -0800913//
914// AAR (android library) prebuilts
915//
Colin Crossfabb6082018-02-20 17:22:23 -0800916
Vinh Trance0781f2022-04-13 01:30:44 +0000917// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800918type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000919 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800920 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000921 // If not blank, set to the version of the sdk to compile against.
922 // Defaults to private.
923 // Values are of one of the following forms:
924 // 1) numerical API level, "current", "none", or "core_platform"
925 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
926 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
927 // If the SDK kind is empty, it will be set to public
928 Sdk_version *string
929 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
930 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700931 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000932 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700933 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000934 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
935 Libs []string
936 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700937 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000938 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
939 // will be passed transitively through android_libraries to an android_app.
940 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
941 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800942}
943
944type AARImport struct {
945 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700946 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900947 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800948 prebuilt android.Prebuilt
949
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900950 // Functionality common to Module and Import.
951 embeddableInModuleAndImport
952
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500953 providesTransitiveHeaderJars
954
Colin Crossfabb6082018-02-20 17:22:23 -0800955 properties AARImportProperties
956
Colin Cross312634e2023-11-21 15:13:56 -0800957 classpathFile android.WritablePath
958 proguardFlags android.WritablePath
959 exportPackage android.WritablePath
960 transitiveAaptResourcePackagesFile android.Path
961 extraAaptPackagesFile android.WritablePath
962 manifest android.WritablePath
963 assetsPackage android.WritablePath
964 rTxt android.WritablePath
965 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700966
Colin Crossab8d1382023-07-14 17:23:41 +0000967 resourcesNodesDepSet *android.DepSet[*resourcesNode]
968 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700969
970 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000971
Sam Delmerico82602492022-06-10 17:05:42 +0000972 aarPath android.Path
973 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900974
975 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000976 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000977
978 // Single aconfig "cache file" merged from this module and all dependencies.
979 mergedAconfigFiles map[string]android.Paths
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000980}
981
982var _ android.OutputFileProducer = (*AARImport)(nil)
983
984// For OutputFileProducer interface
985func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
986 switch tag {
987 case ".aar":
988 return []android.Path{a.aarPath}, nil
989 case "":
990 return []android.Path{a.classpathFile}, nil
991 default:
992 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
993 }
Colin Crossfabb6082018-02-20 17:22:23 -0800994}
995
Jiyong Park92315372021-04-02 08:45:46 +0900996func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
997 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700998}
999
Jiyong Parkf1691d22021-03-29 20:11:58 +09001000func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +01001001 return ""
1002}
1003
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001004func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -07001005 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001006 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -07001007 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001008 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001009}
1010
Spandan Dasa26eda72023-03-02 00:56:06 +00001011func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1012 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001013}
1014
Spandan Dasca70fc42023-03-01 23:38:49 +00001015func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1016 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001017}
1018
Colin Cross1e743852019-10-28 11:37:20 -07001019func (a *AARImport) javaVersion() string {
1020 return ""
1021}
1022
Colin Crossa97c5d32018-03-28 14:58:31 -07001023var _ AndroidLibraryDependency = (*AARImport)(nil)
1024
1025func (a *AARImport) ExportPackage() android.Path {
1026 return a.exportPackage
1027}
Colin Crossab8d1382023-07-14 17:23:41 +00001028func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1029 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001030}
1031
Colin Crossab8d1382023-07-14 17:23:41 +00001032func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1033 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001034}
1035
Colin Crossab8d1382023-07-14 17:23:41 +00001036func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1037 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001038}
1039
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001040// RRO enforcement is not available on aar_import since its RRO dirs are not
1041// exported.
1042func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1043}
1044
1045// RRO enforcement is not available on aar_import since its RRO dirs are not
1046// exported.
1047func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1048 return false
1049}
1050
Colin Crossfabb6082018-02-20 17:22:23 -08001051func (a *AARImport) Prebuilt() *android.Prebuilt {
1052 return &a.prebuilt
1053}
1054
1055func (a *AARImport) Name() string {
1056 return a.prebuilt.Name(a.ModuleBase.Name())
1057}
1058
Jiyong Park618922e2020-01-08 13:35:43 +09001059func (a *AARImport) JacocoReportClassesFile() android.Path {
1060 return nil
1061}
1062
Colin Crossfabb6082018-02-20 17:22:23 -08001063func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001064 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001065 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001066 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001067 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001068 }
1069 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001070
Colin Cross42d48b72018-08-29 14:10:52 -07001071 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1072 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -08001073}
1074
Sam Delmerico82602492022-06-10 17:05:42 +00001075type JniPackageInfo struct {
1076 // List of zip files containing JNI libraries
1077 // Zip files should have directory structure jni/<arch>/*.so
1078 JniPackages android.Paths
1079}
1080
Colin Crossbc7d76c2023-12-12 16:39:03 -08001081var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001082
1083// Unzip an AAR and extract the JNI libs for $archString.
1084var extractJNI = pctx.AndroidStaticRule("extractJNI",
1085 blueprint.RuleParams{
1086 Command: `rm -rf $out $outDir && touch $out && ` +
1087 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1088 `jni_files=$$(find $outDir/jni -type f) && ` +
1089 // print error message if there are no JNI libs for this arch
1090 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001091 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001092 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1093 CommandDeps: []string{"${config.SoongZipCmd}"},
1094 },
1095 "outDir", "archString")
1096
Colin Crossfabb6082018-02-20 17:22:23 -08001097// 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 -07001098// 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 -08001099var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1100 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001101 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001102 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001103 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001104 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001105 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001106 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001107 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001108
1109func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1110 if len(a.properties.Aars) != 1 {
1111 ctx.PropertyErrorf("aars", "exactly one aar is required")
1112 return
1113 }
1114
Jiyong Park92315372021-04-02 08:45:46 +09001115 a.sdkVersion = a.SdkVersion(ctx)
1116 a.minSdkVersion = a.MinSdkVersion(ctx)
1117
Colin Crossff694a82023-12-13 15:54:49 -08001118 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1119 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001120
Nan Zhang4c819fb2018-08-27 18:31:46 -07001121 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001122 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1123
Colin Cross1001a792019-03-21 22:21:39 -07001124 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001125 inputFile := a.aarPath
1126 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1127 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001128 }
Colin Crossfabb6082018-02-20 17:22:23 -08001129
1130 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross205e9112020-08-06 13:20:17 -07001131 a.classpathFile = extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001132 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Cross4eae06d2023-06-20 22:40:02 -07001133 aarRTxt := extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001134 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001135 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross40213022023-12-13 15:19:49 -08001136 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001137 ProguardFlagsFiles: android.NewDepSet[android.Path](
1138 android.POSTORDER,
1139 android.Paths{a.proguardFlags},
1140 nil,
1141 ),
1142 })
Colin Crossfabb6082018-02-20 17:22:23 -08001143
1144 ctx.Build(pctx, android.BuildParams{
1145 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001146 Input: a.aarPath,
Colin Cross4eae06d2023-06-20 22:40:02 -07001147 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, aarRTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001148 Description: "unzip AAR",
1149 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001150 "outDir": extractedAARDir.String(),
1151 "combinedClassesJar": a.classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001152 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001153 },
1154 })
1155
Colin Crossa0ba2f52019-06-22 12:59:27 -07001156 // Always set --pseudo-localize, it will be stripped out later for release
1157 // builds that don't want it.
1158 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001159 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001160 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001161 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001162
1163 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001164 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Cross4eae06d2023-06-20 22:40:02 -07001165 a.rTxt = android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001166 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001167
1168 var linkDeps android.Paths
1169
1170 linkFlags := []string{
1171 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001172 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001173 "--auto-add-overlay",
Colin Cross7c4dc5d2024-02-13 14:29:45 -08001174 "--no-static-lib-packages",
Colin Crossfabb6082018-02-20 17:22:23 -08001175 }
1176
Colin Cross10f7c4a2018-05-23 10:59:28 -07001177 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1178 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001179
Colin Cross8676c8c2023-10-12 15:58:57 -07001180 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001181 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001182
Colin Cross8676c8c2023-10-12 15:58:57 -07001183 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001184 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001185
Colin Crossab8d1382023-07-14 17:23:41 +00001186 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001187
Colin Crossab8d1382023-07-14 17:23:41 +00001188 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001189 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001190 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001191
Colin Cross4eae06d2023-06-20 22:40:02 -07001192 overlayRes := android.Paths{flata}
1193
1194 // Treat static library dependencies of static libraries as imports.
1195 transitiveStaticLibs := staticDeps.resPackages()
1196 linkDeps = append(linkDeps, transitiveStaticLibs...)
1197 for _, staticLib := range transitiveStaticLibs {
1198 linkFlags = append(linkFlags, "-I "+staticLib.String())
1199 }
Colin Crossfabb6082018-02-20 17:22:23 -08001200
Colin Crossab8d1382023-07-14 17:23:41 +00001201 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossf3b7bad2023-08-02 15:49:00 -07001202 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, a.rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001203 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001204
Colin Cross4eae06d2023-06-20 22:40:02 -07001205 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -08001206 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true, nil)
Colin Cross4eae06d2023-06-20 22:40:02 -07001207
Colin Crossf3b7bad2023-08-02 15:49:00 -07001208 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1209
Colin Crossab8d1382023-07-14 17:23:41 +00001210 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1211 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1212 resPackage: a.exportPackage,
1213 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001214 rTxt: a.rTxt,
1215 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001216 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001217
1218 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001219 })
1220 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1221 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1222
1223 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
1224 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
1225 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
1226 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
1227 // android_library_import modules. If this is fixed, AndroidLibraryDependency.ManifestsDepSet can be dropped
1228 // completely in favor of AndroidLibraryDependency.ResourceNodesDepSet.manifest
1229 //manifestDepSetBuilder.Transitive(transitiveStaticDeps.manifests)
1230 _ = staticManifestsDepSet
1231 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001232
Colin Cross312634e2023-11-21 15:13:56 -08001233 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1234 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1235 return p == a.exportPackage.String()
1236 })
1237 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1238 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1239 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001240
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001241 a.collectTransitiveHeaderJars(ctx)
Colin Cross40213022023-12-13 15:19:49 -08001242 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Colin Crossdcf71b22021-02-01 13:59:03 -08001243 HeaderJars: android.PathsIfNonNil(a.classpathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001244 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1245 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08001246 ImplementationAndResourcesJars: android.PathsIfNonNil(a.classpathFile),
1247 ImplementationJars: android.PathsIfNonNil(a.classpathFile),
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001248 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001249 })
Sam Delmerico82602492022-06-10 17:05:42 +00001250
1251 if proptools.Bool(a.properties.Extract_jni) {
1252 for _, t := range ctx.MultiTargets() {
1253 arch := t.Arch.Abi[0]
1254 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1255 a.jniPackages = append(a.jniPackages, path)
1256
1257 outDir := android.PathForModuleOut(ctx, "aarForJni")
1258 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1259 ctx.Build(pctx, android.BuildParams{
1260 Rule: extractJNI,
1261 Input: aarPath,
1262 Outputs: android.WritablePaths{path},
1263 Description: "extract JNI from AAR",
1264 Args: map[string]string{
1265 "outDir": outDir.String(),
1266 "archString": arch,
1267 },
1268 })
1269 }
Sam Delmerico82602492022-06-10 17:05:42 +00001270 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001271
Colin Cross40213022023-12-13 15:19:49 -08001272 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001273 JniPackages: a.jniPackages,
1274 })
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001275 android.CollectDependencyAconfigFiles(ctx, &a.mergedAconfigFiles)
Colin Crossdcf71b22021-02-01 13:59:03 -08001276}
Colin Crossfabb6082018-02-20 17:22:23 -08001277
1278func (a *AARImport) HeaderJars() android.Paths {
1279 return android.Paths{a.classpathFile}
1280}
1281
Colin Cross331a1212018-08-15 20:40:52 -07001282func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
1283 return android.Paths{a.classpathFile}
1284}
1285
Spandan Das59a4a2b2024-01-09 21:35:56 +00001286func (a *AARImport) DexJarBuildPath(ctx android.ModuleErrorfContext) android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001287 return nil
1288}
1289
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001290func (a *AARImport) DexJarInstallPath() android.Path {
1291 return nil
1292}
1293
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001294func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Jiyong Park1be96912018-05-28 18:02:19 +09001295 return nil
1296}
1297
Jiyong Park45bf82e2020-12-15 22:29:02 +09001298var _ android.ApexModule = (*AARImport)(nil)
1299
1300// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001301func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1302 return a.depIsInSameApex(ctx, dep)
1303}
1304
Jiyong Park45bf82e2020-12-15 22:29:02 +09001305// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07001306func (g *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
1307 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001308 return nil
1309}
1310
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001311var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001312
Colin Cross1b16b0e2019-02-12 14:41:32 -08001313// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1314//
1315// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1316// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001317func AARImportFactory() android.Module {
1318 module := &AARImport{}
1319
1320 module.AddProperties(&module.properties)
1321
1322 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001323 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001324 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001325 return module
1326}