blob: 368ad33a9f59ea62e4f7d0991aea5a1ee22bf374 [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 (
Cole Faust6265120c2024-09-05 16:27:56 -070018 "crypto/sha256"
Colin Crossa592e3e2019-02-19 16:59:53 -080019 "fmt"
Jaewoong Jung5b425e22019-06-17 17:40:56 -070020 "path/filepath"
Colin Cross312634e2023-11-21 15:13:56 -080021 "slices"
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"
Jihoon Kangfe914ed2024-02-12 22:49:21 +000026
Colin Crossfabb6082018-02-20 17:22:23 -080027 "github.com/google/blueprint"
Colin Crossa97c5d32018-03-28 14:58:31 -070028 "github.com/google/blueprint/proptools"
Colin Crossfabb6082018-02-20 17:22:23 -080029)
30
Colin Crossa97c5d32018-03-28 14:58:31 -070031type AndroidLibraryDependency interface {
Colin Crossa97c5d32018-03-28 14:58:31 -070032 ExportPackage() android.Path
Colin Crossab8d1382023-07-14 17:23:41 +000033 ResourcesNodeDepSet() *android.DepSet[*resourcesNode]
34 RRODirsDepSet() *android.DepSet[rroDir]
35 ManifestsDepSet() *android.DepSet[android.Path]
Jaewoong Jungc779cd42020-10-06 18:56:10 -070036 SetRROEnforcedForDependent(enforce bool)
37 IsRROEnforced(ctx android.BaseModuleContext) bool
Colin Crossa97c5d32018-03-28 14:58:31 -070038}
39
40func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000041 RegisterAARBuildComponents(android.InitRegistrationContext)
42}
43
44func RegisterAARBuildComponents(ctx android.RegistrationContext) {
45 ctx.RegisterModuleType("android_library_import", AARImportFactory)
46 ctx.RegisterModuleType("android_library", AndroidLibraryFactory)
Paul Duffin04ba70d2021-03-22 13:56:43 +000047 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Cross7e6a9012024-01-17 14:58:38 -080048 ctx.TopDown("propagate_rro_enforcement", propagateRROEnforcementMutator)
Paul Duffin04ba70d2021-03-22 13:56:43 +000049 })
Colin Crossa97c5d32018-03-28 14:58:31 -070050}
51
52//
53// AAR (android library)
54//
55
56type androidLibraryProperties struct {
57 BuildAAR bool `blueprint:"mutated"`
58}
59
60type aaptProperties struct {
61 // flags passed to aapt when creating the apk
62 Aaptflags []string
63
Dan Willemsen72be5902018-10-24 20:24:57 -070064 // include all resource configurations, not just the product-configured
65 // ones.
66 Aapt_include_all_resources *bool
67
Jiakai Zhangba82e282023-10-13 18:08:59 +010068 // list of files to use as assets.
69 Assets []string `android:"path"`
70
Colin Crossa97c5d32018-03-28 14:58:31 -070071 // list of directories relative to the Blueprints file containing assets.
Colin Cross0ddae7f2019-02-07 15:30:01 -080072 // Defaults to ["assets"] if a directory called assets exists. Set to []
73 // to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070074 Asset_dirs []string
75
76 // list of directories relative to the Blueprints file containing
Colin Cross0ddae7f2019-02-07 15:30:01 -080077 // Android resources. Defaults to ["res"] if a directory called res exists.
78 // Set to [] to disable the default.
Cole Faustd65add22024-07-31 16:42:33 -070079 Resource_dirs []string `android:"path"`
Colin Crossa97c5d32018-03-28 14:58:31 -070080
Colin Crossa592e3e2019-02-19 16:59:53 -080081 // list of zip files containing Android resources.
Colin Cross27b922f2019-03-04 22:35:41 -080082 Resource_zips []string `android:"path"`
Colin Crossa592e3e2019-02-19 16:59:53 -080083
Colin Crossa97c5d32018-03-28 14:58:31 -070084 // path to AndroidManifest.xml. If unset, defaults to "AndroidManifest.xml".
Colin Cross27b922f2019-03-04 22:35:41 -080085 Manifest *string `android:"path"`
changho.shinb5432b72019-08-08 18:37:17 +090086
87 // paths to additional manifest files to merge with main manifest.
88 Additional_manifests []string `android:"path"`
Sasha Smundak541056c2019-10-28 15:50:06 -070089
90 // do not include AndroidManifest from dependent libraries
91 Dont_merge_manifests *bool
Jaewoong Jungc779cd42020-10-06 18:56:10 -070092
Colin Cross4eae06d2023-06-20 22:40:02 -070093 // If use_resource_processor is set, use Bazel's resource processor instead of aapt2 to generate R.class files.
94 // The resource processor produces more optimal R.class files that only list resources in the package of the
95 // library that provided them, as opposed to aapt2 which produces R.java files for every package containing
96 // every resource. Using the resource processor can provide significant build time speedups, but requires
97 // fixing the module to use the correct package to reference each resource, and to avoid having any other
98 // libraries in the tree that use the same package name. Defaults to false, but will default to true in the
99 // future.
100 Use_resource_processor *bool
101
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700102 // true if RRO is enforced for any of the dependent modules
103 RROEnforcedForDependent bool `blueprint:"mutated"`
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900104
105 // Filter only specified product and ignore other products
106 Filter_product *string `blueprint:"mutated"`
Jihoon Kang9049c272024-03-19 21:57:36 +0000107
108 // Names of aconfig_declarations modules that specify aconfig flags that the module depends on.
109 Flags_packages []string
Colin Crossa97c5d32018-03-28 14:58:31 -0700110}
111
112type aapt struct {
Colin Cross312634e2023-11-21 15:13:56 -0800113 aaptSrcJar android.Path
114 transitiveAaptRJars android.Paths
115 transitiveAaptResourcePackagesFile android.Path
116 exportPackage android.Path
117 manifestPath android.Path
118 proguardOptionsFile android.Path
119 rTxt android.Path
120 rJar android.Path
121 extraAaptPackagesFile android.Path
122 mergedManifestFile android.Path
123 noticeFile android.OptionalPath
124 assetPackage android.OptionalPath
125 isLibrary bool
126 defaultManifestVersion string
127 useEmbeddedNativeLibs bool
128 useEmbeddedDex bool
129 usesNonSdkApis bool
130 hasNoCode bool
131 LoggingParent string
132 resourceFiles android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700133
Colin Crosse560c4a2019-03-19 16:03:11 -0700134 splitNames []string
135 splits []split
136
Colin Crossa97c5d32018-03-28 14:58:31 -0700137 aaptProperties aaptProperties
Colin Crossab8d1382023-07-14 17:23:41 +0000138
139 resourcesNodesDepSet *android.DepSet[*resourcesNode]
140 rroDirsDepSet *android.DepSet[rroDir]
141 manifestsDepSet *android.DepSet[android.Path]
Alix96ea88452023-08-31 15:48:23 +0000142
143 manifestValues struct {
144 applicationId string
145 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700146}
147
Colin Crosse560c4a2019-03-19 16:03:11 -0700148type split struct {
149 name string
150 suffix string
151 path android.Path
152}
153
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700154// Propagate RRO enforcement flag to static lib dependencies transitively.
155func propagateRROEnforcementMutator(ctx android.TopDownMutatorContext) {
156 m := ctx.Module()
157 if d, ok := m.(AndroidLibraryDependency); ok && d.IsRROEnforced(ctx) {
158 ctx.VisitDirectDepsWithTag(staticLibTag, func(d android.Module) {
159 if a, ok := d.(AndroidLibraryDependency); ok {
160 a.SetRROEnforcedForDependent(true)
161 }
162 })
163 }
164}
165
Colin Cross8f1b0332024-01-25 13:39:06 -0800166func (a *aapt) useResourceProcessorBusyBox(ctx android.BaseModuleContext) bool {
Colin Crosseee4ab12024-03-27 11:54:10 -0700167 return BoolDefault(a.aaptProperties.Use_resource_processor, ctx.Config().UseResourceProcessorByDefault()) &&
168 // TODO(b/331641946): remove this when ResourceProcessorBusyBox supports generating shared libraries.
Spandan Dasa62d9562024-08-06 00:13:31 +0000169 !slices.Contains(a.aaptProperties.Aaptflags, "--shared-lib") &&
170 // Use the legacy resource processor in kythe builds.
171 // The legacy resource processor creates an R.srcjar, which kythe can use for generating crossrefs.
172 // TODO(b/354854007): Re-enable BusyBox in kythe builds
173 !ctx.Config().EmitXrefRules()
Colin Cross4eae06d2023-06-20 22:40:02 -0700174}
175
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900176func (a *aapt) filterProduct() string {
177 return String(a.aaptProperties.Filter_product)
178}
179
Colin Crossa97c5d32018-03-28 14:58:31 -0700180func (a *aapt) ExportPackage() android.Path {
181 return a.exportPackage
182}
Colin Crossab8d1382023-07-14 17:23:41 +0000183func (a *aapt) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
184 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800185}
186
Colin Crossab8d1382023-07-14 17:23:41 +0000187func (a *aapt) RRODirsDepSet() *android.DepSet[rroDir] {
188 return a.rroDirsDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800189}
190
Colin Crossab8d1382023-07-14 17:23:41 +0000191func (a *aapt) ManifestsDepSet() *android.DepSet[android.Path] {
192 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800193}
194
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700195func (a *aapt) SetRROEnforcedForDependent(enforce bool) {
196 a.aaptProperties.RROEnforcedForDependent = enforce
197}
198
199func (a *aapt) IsRROEnforced(ctx android.BaseModuleContext) bool {
200 // True if RRO is enforced for this module or...
201 return ctx.Config().EnforceRROForModule(ctx.ModuleName()) ||
Jeongik Chacee5ba92021-02-19 12:11:51 +0900202 // if RRO is enforced for any of its dependents.
203 a.aaptProperties.RROEnforcedForDependent
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700204}
205
Jiyong Parkf1691d22021-03-29 20:11:58 +0900206func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext android.SdkContext,
Colin Crossa0ba2f52019-06-22 12:59:27 -0700207 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
208 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700209
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800210 hasVersionCode := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-code")
211 hasVersionName := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-name")
Colin Crossa97c5d32018-03-28 14:58:31 -0700212
Colin Crossa97c5d32018-03-28 14:58:31 -0700213 // Flags specified in Android.bp
214 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
215
Eric Miao40eab202023-03-30 16:57:17 +0000216 linkFlags = append(linkFlags, "--enable-compact-entries")
Colin Crossa97c5d32018-03-28 14:58:31 -0700217
218 // Find implicit or explicit asset and resource dirs
Jiakai Zhangba82e282023-10-13 18:08:59 +0100219 assets := android.PathsRelativeToModuleSourceDir(android.SourceInput{
220 Context: ctx,
221 Paths: a.aaptProperties.Assets,
222 IncludeDirs: false,
223 })
Colin Crossa97c5d32018-03-28 14:58:31 -0700224 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
225 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800226 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700227
Colin Crossa97c5d32018-03-28 14:58:31 -0700228 // Glob directories into lists of paths
229 for _, dir := range resourceDirs {
230 resDirs = append(resDirs, globbedResourceDir{
231 dir: dir,
232 files: androidResourceGlob(ctx, dir),
233 })
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700234 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, a, dir)
Colin Crossa97c5d32018-03-28 14:58:31 -0700235 overlayDirs = append(overlayDirs, resOverlayDirs...)
236 rroDirs = append(rroDirs, resRRODirs...)
237 }
238
Cole Faust6265120c2024-09-05 16:27:56 -0700239 assetDirsHasher := sha256.New()
Colin Crossc20dc852020-11-10 12:27:45 -0800240 var assetDeps android.Paths
Cole Faust6265120c2024-09-05 16:27:56 -0700241 for _, dir := range assetDirs {
Colin Crossc20dc852020-11-10 12:27:45 -0800242 // Add a dependency on every file in the asset directory. This ensures the aapt2
243 // rule will be rerun if one of the files in the asset directory is modified.
Cole Faust6265120c2024-09-05 16:27:56 -0700244 dirContents := androidResourceGlob(ctx, dir)
245 assetDeps = append(assetDeps, dirContents...)
Colin Crossc20dc852020-11-10 12:27:45 -0800246
Cole Faust6265120c2024-09-05 16:27:56 -0700247 // Add a hash of all the files in the asset directory to the command line.
Colin Crossc20dc852020-11-10 12:27:45 -0800248 // This ensures the aapt2 rule will be run if a file is removed from the asset directory,
249 // or a file is added whose timestamp is older than the output of aapt2.
Cole Faust6265120c2024-09-05 16:27:56 -0700250 for _, path := range dirContents.Strings() {
251 assetDirsHasher.Write([]byte(path))
252 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700253 }
254
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700255 assetDirStrings := assetDirs.Strings()
256 if a.noticeFile.Valid() {
257 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
Colin Crossc20dc852020-11-10 12:27:45 -0800258 assetDeps = append(assetDeps, a.noticeFile.Path())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700259 }
Jiakai Zhangba82e282023-10-13 18:08:59 +0100260 if len(assets) > 0 {
261 // aapt2 doesn't support adding individual asset files. Create a temp directory to hold asset
262 // files and pass it to aapt2.
263 tmpAssetDir := android.PathForModuleOut(ctx, "tmp_asset_dir")
264
265 rule := android.NewRuleBuilder(pctx, ctx)
266 rule.Command().
267 Text("rm -rf").Text(tmpAssetDir.String()).
268 Text("&&").
269 Text("mkdir -p").Text(tmpAssetDir.String())
270
271 for _, asset := range assets {
272 output := tmpAssetDir.Join(ctx, asset.Rel())
273 assetDeps = append(assetDeps, output)
274 rule.Command().Text("mkdir -p").Text(filepath.Dir(output.String()))
275 rule.Command().Text("cp").Input(asset).Output(output)
276 }
277
278 rule.Build("tmp_asset_dir", "tmp_asset_dir")
279
280 assetDirStrings = append(assetDirStrings, tmpAssetDir.String())
281 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700282
Colin Crossa97c5d32018-03-28 14:58:31 -0700283 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
284 linkDeps = append(linkDeps, manifestPath)
285
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700286 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Cole Faust6265120c2024-09-05 16:27:56 -0700287 linkFlags = append(linkFlags, fmt.Sprintf("$$(: %x)", assetDirsHasher.Sum(nil)))
Colin Crossc20dc852020-11-10 12:27:45 -0800288 linkDeps = append(linkDeps, assetDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700289
Spandan Das50885c02023-02-23 21:31:33 +0000290 // Returns the effective version for {min|target}_sdk_version
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000291 effectiveVersionString := func(sdkVersion android.SdkSpec, minSdkVersion android.ApiLevel) string {
Spandan Das50885c02023-02-23 21:31:33 +0000292 // If {min|target}_sdk_version is current, use sdk_version to determine the effective level
293 // This is necessary for vendor modules.
294 // The effective version does not _only_ depend on {min|target}_sdk_version(level),
295 // but also on the sdk_version (kind+level)
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000296 if minSdkVersion.IsCurrent() {
Spandan Das50885c02023-02-23 21:31:33 +0000297 ret, err := sdkVersion.EffectiveVersionString(ctx)
298 if err != nil {
299 ctx.ModuleErrorf("invalid sdk_version: %s", err)
300 }
301 return ret
302 }
303 ret, err := minSdkVersion.EffectiveVersionString(ctx)
304 if err != nil {
305 ctx.ModuleErrorf("invalid min_sdk_version: %s", err)
306 }
307 return ret
Jiyong Park6a927c42020-01-21 02:03:43 +0900308 }
Spandan Das50885c02023-02-23 21:31:33 +0000309 // SDK version flags
310 sdkVersion := sdkContext.SdkVersion(ctx)
311 minSdkVersion := effectiveVersionString(sdkVersion, sdkContext.MinSdkVersion(ctx))
Colin Crossa97c5d32018-03-28 14:58:31 -0700312
Colin Cross83bb3162018-06-25 15:48:06 -0700313 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
Spandan Das6450b552023-02-23 19:27:07 +0000314 // Use minSdkVersion for target-sdk-version, even if `target_sdk_version` is set
315 // This behavior has been copied from Make.
Colin Cross83bb3162018-06-25 15:48:06 -0700316 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700317
Colin Crossa97c5d32018-03-28 14:58:31 -0700318 // Version code
319 if !hasVersionCode {
Dan Albert4f378d72020-07-23 17:32:15 -0700320 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion().String())
Colin Crossa97c5d32018-03-28 14:58:31 -0700321 }
322
323 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700324 var versionName string
Rashed Abdel-Tawab5b948ab2018-08-09 14:08:53 -0700325 if ctx.ModuleName() == "framework-res" || ctx.ModuleName() == "omnirom-res" {
Colin Cross402d5e02018-04-25 14:54:06 -0700326 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
327 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700328 // if it contains the build number. Use the PlatformVersionName instead.
329 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700330 } else {
331 versionName = ctx.Config().AppsDefaultVersionName()
332 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800333 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700334 linkFlags = append(linkFlags, "--version-name ", versionName)
335 }
336
Colin Crossa0ba2f52019-06-22 12:59:27 -0700337 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
338
339 // Always set --pseudo-localize, it will be stripped out later for release
340 // builds that don't want it.
341 compileFlags = append(compileFlags, "--pseudo-localize")
342
343 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700344}
345
Paul Duffin250e6192019-06-07 10:44:37 +0100346func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800347 if sdkDep.frameworkResModule != "" {
348 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700349 }
Rashed Abdel-Tawab5b948ab2018-08-09 14:08:53 -0700350 if sdkDep.omniromResModule != "" {
351 ctx.AddVariationDependencies(nil, omniromResTag, sdkDep.omniromResModule)
352 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700353}
354
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800355var extractAssetsRule = pctx.AndroidStaticRule("extractAssets",
356 blueprint.RuleParams{
357 Command: `${config.Zip2ZipCmd} -i ${in} -o ${out} "assets/**/*"`,
358 CommandDeps: []string{"${config.Zip2ZipCmd}"},
359 })
360
Alixf7a10272023-09-27 16:47:56 +0000361type aaptBuildActionOptions struct {
362 sdkContext android.SdkContext
363 classLoaderContexts dexpreopt.ClassLoaderContextMap
364 excludedLibs []string
365 enforceDefaultTargetSdkVersion bool
Rico Winda2fa2632024-03-13 13:09:17 +0100366 forceNonFinalResourceIDs bool
Alixf7a10272023-09-27 16:47:56 +0000367 extraLinkFlags []string
Jihoon Kang84b25892023-12-01 22:01:06 +0000368 aconfigTextFiles android.Paths
Jiakai Zhang36937082024-04-15 11:15:50 +0000369 usesLibrary *usesLibrary
Alixf7a10272023-09-27 16:47:56 +0000370}
371
372func (a *aapt) buildActions(ctx android.ModuleContext, opts aaptBuildActionOptions) {
Colin Cross5446e882019-05-22 10:46:27 -0700373
Colin Cross8676c8c2023-10-12 15:58:57 -0700374 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedExportPackages, libFlags :=
Jiakai Zhang36937082024-04-15 11:15:50 +0000375 aaptLibs(ctx, opts.sdkContext, opts.classLoaderContexts, opts.usesLibrary)
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100376
Paul Duffin06530572022-02-03 17:54:15 +0000377 // Exclude any libraries from the supplied list.
Alixf7a10272023-09-27 16:47:56 +0000378 opts.classLoaderContexts = opts.classLoaderContexts.ExcludeLibs(opts.excludedLibs)
Paul Duffin06530572022-02-03 17:54:15 +0000379
Colin Cross31656952018-05-24 16:11:20 -0700380 // App manifest file
381 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
382 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
383
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000384 manifestPath := ManifestFixer(ctx, manifestSrcPath, ManifestFixerParams{
Alixf7a10272023-09-27 16:47:56 +0000385 SdkContext: opts.sdkContext,
386 ClassLoaderContexts: opts.classLoaderContexts,
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000387 IsLibrary: a.isLibrary,
388 DefaultManifestVersion: a.defaultManifestVersion,
389 UseEmbeddedNativeLibs: a.useEmbeddedNativeLibs,
390 UsesNonSdkApis: a.usesNonSdkApis,
391 UseEmbeddedDex: a.useEmbeddedDex,
392 HasNoCode: a.hasNoCode,
393 LoggingParent: a.LoggingParent,
Alixf7a10272023-09-27 16:47:56 +0000394 EnforceDefaultTargetSdkVersion: opts.enforceDefaultTargetSdkVersion,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000395 })
Colin Cross90c25c62019-04-19 16:22:57 -0700396
Colin Crossab8d1382023-07-14 17:23:41 +0000397 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Cross8676c8c2023-10-12 15:58:57 -0700398 sharedDeps := transitiveAarDeps(sharedResourcesNodesDepSet.ToList())
Colin Crossab8d1382023-07-14 17:23:41 +0000399
Luca Stefanifd898822019-09-10 22:13:31 +0200400 // Add additional manifest files to transitive manifests.
401 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
Colin Crossab8d1382023-07-14 17:23:41 +0000402 transitiveManifestPaths := append(android.Paths{manifestPath}, additionalManifests...)
Colin Crossab8d1382023-07-14 17:23:41 +0000403 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700404
Colin Crossab8d1382023-07-14 17:23:41 +0000405 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000406 manifestMergerParams := ManifestMergerParams{
407 staticLibManifests: transitiveManifestPaths[1:],
Alix96ea88452023-08-31 15:48:23 +0000408 isLibrary: a.isLibrary,
409 packageName: a.manifestValues.applicationId,
410 }
Alixf7a10272023-09-27 16:47:56 +0000411 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Crossa6182ab2024-08-21 10:47:44 -0700412 ctx.CheckbuildFile(a.mergedManifestFile)
Colin Cross90c25c62019-04-19 16:22:57 -0700413 if !a.isLibrary {
414 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
415 // will be propagated to the final application and merged there. The merged manifest for libraries is
416 // only passed to Make, which can't handle transitive dependencies.
417 manifestPath = a.mergedManifestFile
418 }
419 } else {
420 a.mergedManifestFile = manifestPath
421 }
Colin Cross31656952018-05-24 16:11:20 -0700422
Alixf7a10272023-09-27 16:47:56 +0000423 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700424
425 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700426 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000427 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000428 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700429 if a.isLibrary {
430 linkFlags = append(linkFlags, "--static-lib")
431 }
Rico Wind7152e822024-04-19 08:14:15 +0200432 if opts.forceNonFinalResourceIDs {
433 linkFlags = append(linkFlags, "--non-final-ids")
434 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700435
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800436 linkFlags = append(linkFlags, "--no-static-lib-packages")
Colin Cross8f1b0332024-01-25 13:39:06 -0800437 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800438 // When building an android_library using ResourceProcessorBusyBox pass --merge-only to skip resource
439 // references validation until the final app link step when all static libraries are present.
Colin Cross4eae06d2023-06-20 22:40:02 -0700440 linkFlags = append(linkFlags, "--merge-only")
Colin Cross4eae06d2023-06-20 22:40:02 -0700441 }
442
Colin Crossa97c5d32018-03-28 14:58:31 -0700443 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700444 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
445 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700446 // This file isn't used by Soong, but is generated for exporting
447 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700448 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700449 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700450
Colin Cross4aaa84a2018-08-21 15:14:37 -0700451 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700452 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700453 a.resourceFiles = append(a.resourceFiles, dir.files...)
Jihoon Kang98ea8362024-07-16 18:20:03 +0000454 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files,
455 compileFlags, a.filterProduct(), opts.aconfigTextFiles).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700456 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700457
Colin Crossa592e3e2019-02-19 16:59:53 -0800458 for i, zip := range resZips {
459 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700460 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800461 compiledResDirs = append(compiledResDirs, android.Paths{flata})
462 }
463
Colin Cross4aaa84a2018-08-21 15:14:37 -0700464 var compiledRes, compiledOverlay android.Paths
465
Colin Crossab8d1382023-07-14 17:23:41 +0000466 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
467 // of transitiveStaticLibs.
468 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
469
Colin Cross8f1b0332024-01-25 13:39:06 -0800470 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700471 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
472 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
473 // instead modules depending on this module will reference package-res.apk from all transitive static
474 // dependencies.
Colin Cross1d3f5902024-03-05 11:51:54 -0800475 for _, sharedDep := range sharedDeps {
476 if sharedDep.usedResourceProcessor {
477 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
478 }
479 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700480 for _, staticDep := range staticDeps {
481 linkDeps = append(linkDeps, staticDep.resPackage)
482 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
483 if staticDep.usedResourceProcessor {
484 transitiveRJars = append(transitiveRJars, staticDep.rJar)
485 }
486 }
487 } else {
488 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
489 // dependencies are compiled into this module's package-res.apk as overlays.
490 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
491 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700492
Colin Crossbec85302019-02-13 13:15:46 -0800493 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700494 // If we are using static android libraries, every source file becomes an overlay.
495 // This is to emulate old AAPT behavior which simulated library support.
496 for _, compiledResDir := range compiledResDirs {
497 compiledOverlay = append(compiledOverlay, compiledResDir...)
498 }
Colin Crossbec85302019-02-13 13:15:46 -0800499 } else if a.isLibrary {
500 // Otherwise, for a static library we treat all the resources equally with no overlay.
501 for _, compiledResDir := range compiledResDirs {
502 compiledRes = append(compiledRes, compiledResDir...)
503 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700504 } else if len(compiledResDirs) > 0 {
505 // Without static libraries, the first directory is our directory, which can then be
506 // overlaid by the rest.
507 compiledRes = append(compiledRes, compiledResDirs[0]...)
508 for _, compiledResDir := range compiledResDirs[1:] {
509 compiledOverlay = append(compiledOverlay, compiledResDir...)
510 }
511 }
512
Colin Crossa97c5d32018-03-28 14:58:31 -0700513 for _, dir := range overlayDirs {
Jihoon Kang98ea8362024-07-16 18:20:03 +0000514 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files,
515 compileFlags, a.filterProduct(), opts.aconfigTextFiles).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700516 }
517
Colin Crosse560c4a2019-03-19 16:03:11 -0700518 var splitPackages android.WritablePaths
519 var splits []split
520
521 for _, s := range a.splitNames {
522 suffix := strings.Replace(s, ",", "_", -1)
523 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
524 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
525 splitPackages = append(splitPackages, path)
526 splits = append(splits, split{
527 name: s,
528 suffix: suffix,
529 path: path,
530 })
531 }
532
Colin Cross8f1b0332024-01-25 13:39:06 -0800533 if !a.useResourceProcessorBusyBox(ctx) {
Colin Crossf3b7bad2023-08-02 15:49:00 -0700534 // the subdir "android" is required to be filtered by package names
535 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
536 }
537
Colin Crossab8d1382023-07-14 17:23:41 +0000538 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
539 // provided to the final app aapt2Link step.
540 var transitiveAssets android.Paths
541 if !a.isLibrary {
542 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
543 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700544 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000545 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
546 opts.aconfigTextFiles)
Colin Crossa6182ab2024-08-21 10:47:44 -0700547 ctx.CheckbuildFile(packageRes)
548
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800549 // Extract assets from the resource package output so that they can be used later in aapt2link
550 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000551 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800552 assets := android.PathForModuleOut(ctx, "assets.zip")
553 ctx.Build(pctx, android.BuildParams{
554 Rule: extractAssetsRule,
555 Input: packageRes,
556 Output: assets,
557 Description: "extract assets from built resource file",
558 })
559 a.assetPackage = android.OptionalPathForPath(assets)
560 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700561
Colin Cross8f1b0332024-01-25 13:39:06 -0800562 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700563 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
Rico Winda2fa2632024-03-13 13:09:17 +0100564 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary, a.aaptProperties.Aaptflags,
565 opts.forceNonFinalResourceIDs)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700566 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700567 transitiveRJars = append(transitiveRJars, rJar)
568 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700569 } else {
570 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700571 }
572
Colin Cross312634e2023-11-21 15:13:56 -0800573 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
574 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
575 return p == packageRes.String()
576 })
577 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
578 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
579
Colin Cross1d3f5902024-03-05 11:51:54 -0800580 // Reverse the list of R.jar files so that the current module comes first, and direct dependencies come before
581 // transitive dependencies.
582 transitiveRJars = android.ReversePaths(transitiveRJars)
583
Colin Crossa97c5d32018-03-28 14:58:31 -0700584 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700585 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800586 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700587 a.exportPackage = packageRes
588 a.manifestPath = manifestPath
589 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700590 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700591 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700592 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000593 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
594 Direct(&resourcesNode{
595 resPackage: a.exportPackage,
596 manifest: a.manifestPath,
597 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700598 rTxt: a.rTxt,
599 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000600 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700601
Colin Cross8f1b0332024-01-25 13:39:06 -0800602 usedResourceProcessor: a.useResourceProcessorBusyBox(ctx),
Colin Crossab8d1382023-07-14 17:23:41 +0000603 }).
604 Transitive(staticResourcesNodesDepSet).Build()
605 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
606 Direct(rroDirs...).
607 Transitive(staticRRODirsDepSet).Build()
608 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
609 Direct(a.manifestPath).
610 DirectSlice(additionalManifests).
611 Transitive(staticManifestsDepSet).Build()
612}
613
Colin Cross4eae06d2023-06-20 22:40:02 -0700614var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
615 blueprint.RuleParams{
616 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
617 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
618 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
619 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
620 Rspfile: "${out}.args",
621 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
622 Restat: true,
623 }, "rTxt", "manifest", "args")
624
625// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
626// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
627// supports producing classes for static dependencies that only include resources from that dependency.
628func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
Rico Winda2fa2632024-03-13 13:09:17 +0100629 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool, aaptFlags []string,
630 forceNonFinalIds bool) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700631
632 var args []string
633 var deps android.Paths
634
635 if !isLibrary {
636 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
637 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
638 // package.
639 args, deps = transitiveDeps.resourceProcessorDeps()
Rico Winda2fa2632024-03-13 13:09:17 +0100640 if forceNonFinalIds {
641 args = append(args, "--finalFields=false")
642 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700643 } else {
644 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
645 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
646 // inlined into the library before the final IDs are assigned during app compilation.
647 args = append(args, "--finalFields=false")
648 }
649
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800650 for i, arg := range aaptFlags {
651 const AAPT_CUSTOM_PACKAGE = "--custom-package"
652 if strings.HasPrefix(arg, AAPT_CUSTOM_PACKAGE) {
653 pkg := strings.TrimSpace(strings.TrimPrefix(arg, AAPT_CUSTOM_PACKAGE))
654 if pkg == "" && i+1 < len(aaptFlags) {
655 pkg = aaptFlags[i+1]
656 }
657 args = append(args, "--packageForR "+pkg)
658 }
659 }
660
Colin Cross4eae06d2023-06-20 22:40:02 -0700661 deps = append(deps, rTxt, manifest)
662
663 ctx.Build(pctx, android.BuildParams{
664 Rule: resourceProcessorBusyBox,
665 Output: rJar,
666 Implicits: deps,
667 Description: "ResourceProcessorBusyBox",
668 Args: map[string]string{
669 "rTxt": rTxt.String(),
670 "manifest": manifest.String(),
671 "args": strings.Join(args, " "),
672 },
673 })
674}
675
Colin Crossab8d1382023-07-14 17:23:41 +0000676type resourcesNode struct {
677 resPackage android.Path
678 manifest android.Path
679 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700680 rTxt android.Path
681 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000682 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700683
684 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000685}
686
687type transitiveAarDeps []*resourcesNode
688
689func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700690 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000691 for _, dep := range t {
692 paths = append(paths, dep.resPackage)
693 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700694 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000695}
696
697func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700698 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000699 for _, dep := range t {
700 paths = append(paths, dep.manifest)
701 paths = append(paths, dep.additionalManifests...)
702 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700703 return paths
704}
705
706func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
707 for _, dep := range t {
708 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
709 deps = append(deps, dep.rTxt, dep.manifest)
710 }
711 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000712}
713
714func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700715 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000716 for _, dep := range t {
717 if dep.assets.Valid() {
718 paths = append(paths, dep.assets.Path())
719 }
720 }
721 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700722}
723
724// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiakai Zhang36937082024-04-15 11:15:50 +0000725func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext,
726 classLoaderContexts dexpreopt.ClassLoaderContextMap, usesLibrary *usesLibrary) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700727 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000728 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700729
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100730 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000731 // Not all callers need to compute class loader context, those who don't just pass nil.
732 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100733 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000734 }
735
Colin Cross83bb3162018-06-25 15:48:06 -0700736 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700737 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700738 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700739 }
740
Colin Cross8676c8c2023-10-12 15:58:57 -0700741 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
742 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000743 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
744 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
745
Colin Crossa97c5d32018-03-28 14:58:31 -0700746 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000747 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000748
Colin Crossa97c5d32018-03-28 14:58:31 -0700749 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700750 aarDep, _ := module.(AndroidLibraryDependency)
751 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700752 exportPackage = aarDep.ExportPackage()
753 }
754
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000755 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700756 case instrumentationForTag:
757 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400758 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700759 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700760 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700761 sharedLibs = append(sharedLibs, exportPackage)
762 }
Rashed Abdel-Tawab5b948ab2018-08-09 14:08:53 -0700763 case frameworkResTag, omniromResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700764 if exportPackage != nil {
765 sharedLibs = append(sharedLibs, exportPackage)
766 }
767 case staticLibTag:
768 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700769 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000770 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
771 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700772 }
773 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000774
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000775 addCLCFromDep(ctx, module, classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +0000776 if usesLibrary != nil {
777 addMissingOptionalUsesLibsFromDep(ctx, module, usesLibrary)
778 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700779 })
780
Colin Crossab8d1382023-07-14 17:23:41 +0000781 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
782 // Reverse the dependency order now going into the depset so that it comes out in order after the second
783 // reverse later.
784 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
785 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
Colin Cross9055e212024-03-23 04:43:41 +0000786 // dependency has to be listed last. This is also inconsistent with the way manifests from the same
787 // transitive dependencies are merged.
Colin Crossab8d1382023-07-14 17:23:41 +0000788 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700789 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
790 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
791 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700792
Colin Crossab8d1382023-07-14 17:23:41 +0000793 staticRRODirs = rroDirsDepSetBuilder.Build()
794 staticManifests = manifestsDepSetBuilder.Build()
795
796 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700797 flags = append(flags, "--auto-add-overlay")
798 }
799
800 for _, sharedLib := range sharedLibs {
801 flags = append(flags, "-I "+sharedLib.String())
802 }
803
Colin Cross8676c8c2023-10-12 15:58:57 -0700804 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700805}
806
807type AndroidLibrary struct {
808 Library
809 aapt
810
811 androidLibraryProperties androidLibraryProperties
812
813 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700814}
815
Colin Crossa97c5d32018-03-28 14:58:31 -0700816var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
817
818func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000819 a.usesLibrary.deps(ctx, false)
Colin Crossa97c5d32018-03-28 14:58:31 -0700820 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900821 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100822 if sdkDep.hasFrameworkLibs() {
823 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700824 }
Jihoon Kang9049c272024-03-19 21:57:36 +0000825
826 for _, aconfig_declaration := range a.aaptProperties.Flags_packages {
827 ctx.AddDependency(ctx.Module(), aconfigDeclarationTag, aconfig_declaration)
828 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700829}
830
831func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800832 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100833 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Spandan Das0727ba72024-02-13 16:37:43 +0000834 if a.usesLibrary.shouldDisableDexpreopt {
835 a.dexpreopter.disableDexpreopt()
836 }
Jihoon Kang9aef7772024-06-14 23:45:06 +0000837 aconfigTextFilePaths := getAconfigFilePaths(ctx)
Alixf7a10272023-09-27 16:47:56 +0000838 a.aapt.buildActions(ctx,
839 aaptBuildActionOptions{
840 sdkContext: android.SdkContext(a),
841 classLoaderContexts: a.classLoaderContexts,
842 enforceDefaultTargetSdkVersion: false,
Jihoon Kang9aef7772024-06-14 23:45:06 +0000843 aconfigTextFiles: aconfigTextFilePaths,
Jiakai Zhang36937082024-04-15 11:15:50 +0000844 usesLibrary: &a.usesLibrary,
Alixf7a10272023-09-27 16:47:56 +0000845 },
846 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700847
Colin Crossff694a82023-12-13 15:54:49 -0800848 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
849 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700850
yangbill2af0b6e2024-03-15 09:29:29 +0000851 a.stem = proptools.StringDefault(a.overridableProperties.Stem, ctx.ModuleName())
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000852
Colin Cross4eae06d2023-06-20 22:40:02 -0700853 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
854 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross8f1b0332024-01-25 13:39:06 -0800855 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700856 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700857 } else {
858 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700859 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700860
861 // apps manifests are handled by aapt, don't let Module see them
862 a.properties.Manifest = nil
863
Colin Cross014489c2020-06-02 20:09:13 -0700864 a.linter.mergedManifest = a.aapt.mergedManifestFile
865 a.linter.manifest = a.aapt.manifestPath
866 a.linter.resources = a.aapt.resourceFiles
867
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000868 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800869 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800870 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
871 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
872 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
873
874 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
875 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
876 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700877
Colin Cross4eae06d2023-06-20 22:40:02 -0700878 var extraSrcJars android.Paths
879 var extraCombinedJars android.Paths
880 var extraClasspathJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800881 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700882 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
883 // library and each of the transitive static android_library dependencies has already created an
884 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
885 extraClasspathJars = a.transitiveAaptRJars
886 } else {
887 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
888 // R.java files for the library's package and the packages from all transitive static android_library
889 // dependencies. Compile the srcjar alongside the rest of the sources.
890 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
891 }
892
Colin Crossfdaa6722024-08-23 11:58:08 -0700893 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars, nil)
Colin Crossa97c5d32018-03-28 14:58:31 -0700894
Colin Crossf57c5782019-01-25 13:20:38 -0800895 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700896 var res android.Paths
897 if a.androidLibraryProperties.BuildAAR {
898 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
Colin Crossa97c5d32018-03-28 14:58:31 -0700899 }
Colin Cross89c31582018-04-30 15:55:11 -0700900
Sam Delmerico82602492022-06-10 17:05:42 +0000901 prebuiltJniPackages := android.Paths{}
902 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800903 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000904 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
905 }
906 })
907 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800908 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000909 JniPackages: prebuiltJniPackages,
910 })
911 }
Jihoon Kang9aef7772024-06-14 23:45:06 +0000912
913 android.SetProvider(ctx, FlagsPackagesProvider, FlagsPackages{
914 AconfigTextFiles: aconfigTextFilePaths,
915 })
mrziwang9f7b9f42024-07-10 12:18:06 -0700916
917 a.setOutputFiles(ctx)
Colin Crossa97c5d32018-03-28 14:58:31 -0700918}
919
mrziwang9f7b9f42024-07-10 12:18:06 -0700920func (a *AndroidLibrary) setOutputFiles(ctx android.ModuleContext) {
921 ctx.SetOutputFiles([]android.Path{a.aarFile}, ".aar")
922 setOutputFiles(ctx, a.Library.Module)
Colin Cross95b53b82023-10-17 13:21:02 -0700923}
924
Cole Faustb36d31d2024-08-27 16:04:28 -0700925func (a *AndroidLibrary) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
926 a.Library.IDEInfo(ctx, dpInfo)
927 a.aapt.IDEInfo(ctx, dpInfo)
Colin Cross95b53b82023-10-17 13:21:02 -0700928}
929
Cole Faustb36d31d2024-08-27 16:04:28 -0700930func (a *aapt) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Colin Cross8f1b0332024-01-25 13:39:06 -0800931 if a.rJar != nil {
Colin Cross95b53b82023-10-17 13:21:02 -0700932 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
933 }
934}
935
Colin Cross1b16b0e2019-02-12 14:41:32 -0800936// android_library builds and links sources into a `.jar` file for the device along with Android resources.
937//
938// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000939// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800940// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
941// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700942func AndroidLibraryFactory() android.Module {
943 module := &AndroidLibrary{}
944
Colin Crossce6734e2020-06-15 16:09:53 -0700945 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700946 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700947 &module.aaptProperties,
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700948 &module.androidLibraryProperties,
949 &module.sourceProperties)
Colin Crossa97c5d32018-03-28 14:58:31 -0700950
951 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700952 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700953
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900954 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700955 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700956 return module
957}
958
Colin Crossfabb6082018-02-20 17:22:23 -0800959//
960// AAR (android library) prebuilts
961//
Colin Crossfabb6082018-02-20 17:22:23 -0800962
Vinh Trance0781f2022-04-13 01:30:44 +0000963// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800964type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000965 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800966 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000967 // If not blank, set to the version of the sdk to compile against.
968 // Defaults to private.
969 // Values are of one of the following forms:
970 // 1) numerical API level, "current", "none", or "core_platform"
971 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
972 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
973 // If the SDK kind is empty, it will be set to public
974 Sdk_version *string
975 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
976 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700977 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000978 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Cole Faustb7493472024-08-28 11:55:52 -0700979 Static_libs proptools.Configurable[[]string]
Vinh Trance0781f2022-04-13 01:30:44 +0000980 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
981 Libs []string
982 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700983 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000984 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
985 // will be passed transitively through android_libraries to an android_app.
986 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
987 Extract_jni *bool
Colin Cross21ed4692024-04-24 20:23:38 +0000988
989 // If set, overrides the manifest extracted from the AAR with the provided path.
990 Manifest *string `android:"path"`
Colin Crossfabb6082018-02-20 17:22:23 -0800991}
992
993type AARImport struct {
994 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700995 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900996 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800997 prebuilt android.Prebuilt
998
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900999 // Functionality common to Module and Import.
1000 embeddableInModuleAndImport
1001
Colin Cross9ffaf282024-08-12 13:50:09 -07001002 providesTransitiveHeaderJarsForR8
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001003
Colin Crossfabb6082018-02-20 17:22:23 -08001004 properties AARImportProperties
1005
Colin Cross7707b242024-07-26 12:02:36 -07001006 headerJarFile android.Path
1007 implementationJarFile android.Path
1008 implementationAndResourcesJarFile android.Path
1009 proguardFlags android.Path
1010 exportPackage android.Path
Colin Cross312634e2023-11-21 15:13:56 -08001011 transitiveAaptResourcePackagesFile android.Path
Colin Cross7707b242024-07-26 12:02:36 -07001012 extraAaptPackagesFile android.Path
Colin Cross21ed4692024-04-24 20:23:38 +00001013 manifest android.Path
Colin Cross7707b242024-07-26 12:02:36 -07001014 assetsPackage android.Path
1015 rTxt android.Path
1016 rJar android.Path
Colin Cross66f78822018-05-02 12:58:28 -07001017
Colin Crossab8d1382023-07-14 17:23:41 +00001018 resourcesNodesDepSet *android.DepSet[*resourcesNode]
1019 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -07001020
1021 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001022
Sam Delmerico82602492022-06-10 17:05:42 +00001023 aarPath android.Path
1024 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +09001025
1026 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001027 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001028
Colin Cross9055e212024-03-23 04:43:41 +00001029 usesLibrary
1030 classLoaderContexts dexpreopt.ClassLoaderContextMap
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001031}
1032
Jiyong Park92315372021-04-02 08:45:46 +09001033func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1034 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07001035}
1036
Jiyong Parkf1691d22021-03-29 20:11:58 +09001037func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +01001038 return ""
1039}
1040
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001041func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -07001042 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001043 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -07001044 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001045 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001046}
1047
Spandan Dasa26eda72023-03-02 00:56:06 +00001048func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1049 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001050}
1051
Spandan Dasca70fc42023-03-01 23:38:49 +00001052func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1053 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001054}
1055
Colin Cross1e743852019-10-28 11:37:20 -07001056func (a *AARImport) javaVersion() string {
1057 return ""
1058}
1059
Colin Crossa97c5d32018-03-28 14:58:31 -07001060var _ AndroidLibraryDependency = (*AARImport)(nil)
1061
1062func (a *AARImport) ExportPackage() android.Path {
1063 return a.exportPackage
1064}
Colin Crossab8d1382023-07-14 17:23:41 +00001065func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1066 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001067}
1068
Colin Crossab8d1382023-07-14 17:23:41 +00001069func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1070 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001071}
1072
Colin Crossab8d1382023-07-14 17:23:41 +00001073func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1074 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001075}
1076
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001077// RRO enforcement is not available on aar_import since its RRO dirs are not
1078// exported.
1079func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1080}
1081
1082// RRO enforcement is not available on aar_import since its RRO dirs are not
1083// exported.
1084func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1085 return false
1086}
1087
Colin Crossfabb6082018-02-20 17:22:23 -08001088func (a *AARImport) Prebuilt() *android.Prebuilt {
1089 return &a.prebuilt
1090}
1091
1092func (a *AARImport) Name() string {
1093 return a.prebuilt.Name(a.ModuleBase.Name())
1094}
1095
Jiyong Park618922e2020-01-08 13:35:43 +09001096func (a *AARImport) JacocoReportClassesFile() android.Path {
1097 return nil
1098}
1099
Colin Crossfabb6082018-02-20 17:22:23 -08001100func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001101 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001102 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001103 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001104 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001105 }
Rashed Abdel-Tawab5b948ab2018-08-09 14:08:53 -07001106 if sdkDep.useModule && sdkDep.omniromResModule != "" {
1107 ctx.AddVariationDependencies(nil, omniromResTag, sdkDep.omniromResModule)
1108 }
Colin Crossfabb6082018-02-20 17:22:23 -08001109 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001110
Colin Cross42d48b72018-08-29 14:10:52 -07001111 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
Cole Faustb7493472024-08-28 11:55:52 -07001112 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs.GetOrDefault(ctx, nil)...)
Colin Cross9055e212024-03-23 04:43:41 +00001113
1114 a.usesLibrary.deps(ctx, false)
Colin Crossfabb6082018-02-20 17:22:23 -08001115}
1116
Sam Delmerico82602492022-06-10 17:05:42 +00001117type JniPackageInfo struct {
1118 // List of zip files containing JNI libraries
1119 // Zip files should have directory structure jni/<arch>/*.so
1120 JniPackages android.Paths
1121}
1122
Colin Crossbc7d76c2023-12-12 16:39:03 -08001123var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001124
1125// Unzip an AAR and extract the JNI libs for $archString.
1126var extractJNI = pctx.AndroidStaticRule("extractJNI",
1127 blueprint.RuleParams{
1128 Command: `rm -rf $out $outDir && touch $out && ` +
1129 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1130 `jni_files=$$(find $outDir/jni -type f) && ` +
1131 // print error message if there are no JNI libs for this arch
1132 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001133 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001134 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1135 CommandDeps: []string{"${config.SoongZipCmd}"},
1136 },
1137 "outDir", "archString")
1138
Colin Crossfabb6082018-02-20 17:22:23 -08001139// 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 -07001140// 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 -08001141var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1142 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001143 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001144 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001145 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001146 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001147 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001148 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001149 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001150
1151func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1152 if len(a.properties.Aars) != 1 {
1153 ctx.PropertyErrorf("aars", "exactly one aar is required")
1154 return
1155 }
1156
Jiyong Park92315372021-04-02 08:45:46 +09001157 a.sdkVersion = a.SdkVersion(ctx)
1158 a.minSdkVersion = a.MinSdkVersion(ctx)
1159
Colin Crossff694a82023-12-13 15:54:49 -08001160 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1161 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001162
Nan Zhang4c819fb2018-08-27 18:31:46 -07001163 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001164 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1165
Colin Cross1001a792019-03-21 22:21:39 -07001166 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001167 inputFile := a.aarPath
Colin Cross77965d92024-08-15 17:11:08 -07001168 jetifierPath := android.PathForModuleOut(ctx, "jetifier", aarName)
1169 TransformJetifier(ctx, jetifierPath, inputFile)
1170 a.aarPath = jetifierPath
Nan Zhang4c819fb2018-08-27 18:31:46 -07001171 }
Colin Crossfabb6082018-02-20 17:22:23 -08001172
Colin Cross607bbd62024-04-12 13:44:45 -07001173 jarName := ctx.ModuleName() + ".jar"
Colin Crossfabb6082018-02-20 17:22:23 -08001174 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross607bbd62024-04-12 13:44:45 -07001175 classpathFile := extractedAARDir.Join(ctx, jarName)
Colin Cross21ed4692024-04-24 20:23:38 +00001176
1177 extractedManifest := extractedAARDir.Join(ctx, "AndroidManifest.xml")
1178 providedManifest := android.OptionalPathForModuleSrc(ctx, a.properties.Manifest)
1179 if providedManifest.Valid() {
1180 a.manifest = providedManifest.Path()
1181 } else {
1182 a.manifest = extractedManifest
1183 }
1184
Colin Cross7707b242024-07-26 12:02:36 -07001185 rTxt := extractedAARDir.Join(ctx, "R.txt")
1186 assetsPackage := android.PathForModuleOut(ctx, "assets.zip")
1187 proguardFlags := extractedAARDir.Join(ctx, "proguard.txt")
Colin Crosscde55342024-03-27 14:11:51 -07001188 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -08001189 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001190 ProguardFlagsFiles: android.NewDepSet[android.Path](
1191 android.POSTORDER,
Colin Cross7707b242024-07-26 12:02:36 -07001192 android.Paths{proguardFlags},
Colin Crosscde55342024-03-27 14:11:51 -07001193 transitiveProguardFlags,
1194 ),
1195 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1196 android.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001197 nil,
Colin Crosscde55342024-03-27 14:11:51 -07001198 transitiveUnconditionalExportedFlags,
Sam Delmerico95d70942023-08-02 18:00:35 -04001199 ),
1200 })
Colin Crossfabb6082018-02-20 17:22:23 -08001201
1202 ctx.Build(pctx, android.BuildParams{
1203 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001204 Input: a.aarPath,
Colin Cross7707b242024-07-26 12:02:36 -07001205 Outputs: android.WritablePaths{classpathFile, proguardFlags, extractedManifest, assetsPackage, rTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001206 Description: "unzip AAR",
1207 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001208 "outDir": extractedAARDir.String(),
Colin Cross9055e212024-03-23 04:43:41 +00001209 "combinedClassesJar": classpathFile.String(),
Colin Cross7707b242024-07-26 12:02:36 -07001210 "assetsPackage": assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001211 },
1212 })
1213
Colin Cross7707b242024-07-26 12:02:36 -07001214 a.proguardFlags = proguardFlags
1215 a.assetsPackage = assetsPackage
1216 a.rTxt = rTxt
1217
Colin Crossa0ba2f52019-06-22 12:59:27 -07001218 // Always set --pseudo-localize, it will be stripped out later for release
1219 // builds that don't want it.
1220 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001221 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001222 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001223 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001224
Colin Cross7707b242024-07-26 12:02:36 -07001225 exportPackage := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001226 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001227 aaptRTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross7707b242024-07-26 12:02:36 -07001228 extraAaptPackagesFile := android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001229
1230 var linkDeps android.Paths
1231
1232 linkFlags := []string{
1233 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001234 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001235 "--auto-add-overlay",
Colin Cross7c4dc5d2024-02-13 14:29:45 -08001236 "--no-static-lib-packages",
Colin Crossfabb6082018-02-20 17:22:23 -08001237 }
1238
Colin Cross10f7c4a2018-05-23 10:59:28 -07001239 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1240 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001241
Colin Cross8676c8c2023-10-12 15:58:57 -07001242 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiakai Zhang36937082024-04-15 11:15:50 +00001243 aaptLibs(ctx, android.SdkContext(a), nil, nil)
Colin Cross31656952018-05-24 16:11:20 -07001244
Colin Cross8676c8c2023-10-12 15:58:57 -07001245 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001246 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001247
Colin Crossab8d1382023-07-14 17:23:41 +00001248 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001249
Colin Crossab8d1382023-07-14 17:23:41 +00001250 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001251 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001252 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001253
Colin Cross4eae06d2023-06-20 22:40:02 -07001254 overlayRes := android.Paths{flata}
1255
1256 // Treat static library dependencies of static libraries as imports.
1257 transitiveStaticLibs := staticDeps.resPackages()
1258 linkDeps = append(linkDeps, transitiveStaticLibs...)
1259 for _, staticLib := range transitiveStaticLibs {
1260 linkFlags = append(linkFlags, "-I "+staticLib.String())
1261 }
Colin Crossfabb6082018-02-20 17:22:23 -08001262
Colin Crossab8d1382023-07-14 17:23:41 +00001263 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Cross7707b242024-07-26 12:02:36 -07001264 aapt2Link(ctx, exportPackage, nil, proguardOptionsFile, aaptRTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001265 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossa6182ab2024-08-21 10:47:44 -07001266 ctx.CheckbuildFile(exportPackage)
Colin Cross7707b242024-07-26 12:02:36 -07001267 a.exportPackage = exportPackage
Colin Crossfabb6082018-02-20 17:22:23 -08001268
Colin Cross7707b242024-07-26 12:02:36 -07001269 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
1270 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, rJar, nil, true, nil, false)
Colin Crossa6182ab2024-08-21 10:47:44 -07001271 ctx.CheckbuildFile(rJar)
Colin Cross7707b242024-07-26 12:02:36 -07001272 a.rJar = rJar
Colin Cross4eae06d2023-06-20 22:40:02 -07001273
Colin Cross7707b242024-07-26 12:02:36 -07001274 aapt2ExtractExtraPackages(ctx, extraAaptPackagesFile, a.rJar)
1275 a.extraAaptPackagesFile = extraAaptPackagesFile
Colin Crossf3b7bad2023-08-02 15:49:00 -07001276
Colin Crossab8d1382023-07-14 17:23:41 +00001277 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1278 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1279 resPackage: a.exportPackage,
1280 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001281 rTxt: a.rTxt,
1282 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001283 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001284
1285 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001286 })
1287 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1288 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1289
1290 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
Colin Cross9055e212024-03-23 04:43:41 +00001291 manifestDepSetBuilder.Transitive(staticManifestsDepSet)
Colin Crossab8d1382023-07-14 17:23:41 +00001292 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001293
Colin Cross312634e2023-11-21 15:13:56 -08001294 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1295 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1296 return p == a.exportPackage.String()
1297 })
1298 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1299 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1300 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001301
Colin Cross9ffaf282024-08-12 13:50:09 -07001302 a.collectTransitiveHeaderJarsForR8(ctx)
Colin Cross9055e212024-03-23 04:43:41 +00001303
1304 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
1305
1306 var staticJars android.Paths
1307 var staticHeaderJars android.Paths
Colin Cross607bbd62024-04-12 13:44:45 -07001308 var staticResourceJars android.Paths
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001309 var transitiveStaticLibsHeaderJars []*android.DepSet[android.Path]
1310 var transitiveStaticLibsImplementationJars []*android.DepSet[android.Path]
1311 var transitiveStaticLibsResourceJars []*android.DepSet[android.Path]
1312
Colin Cross9055e212024-03-23 04:43:41 +00001313 ctx.VisitDirectDeps(func(module android.Module) {
1314 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
1315 tag := ctx.OtherModuleDependencyTag(module)
1316 switch tag {
1317 case staticLibTag:
1318 staticJars = append(staticJars, dep.ImplementationJars...)
1319 staticHeaderJars = append(staticHeaderJars, dep.HeaderJars...)
Colin Cross607bbd62024-04-12 13:44:45 -07001320 staticResourceJars = append(staticResourceJars, dep.ResourceJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001321 if dep.TransitiveStaticLibsHeaderJars != nil {
1322 transitiveStaticLibsHeaderJars = append(transitiveStaticLibsHeaderJars, dep.TransitiveStaticLibsHeaderJars)
1323 }
1324 if dep.TransitiveStaticLibsImplementationJars != nil {
1325 transitiveStaticLibsImplementationJars = append(transitiveStaticLibsImplementationJars, dep.TransitiveStaticLibsImplementationJars)
1326 }
1327 if dep.TransitiveStaticLibsResourceJars != nil {
1328 transitiveStaticLibsResourceJars = append(transitiveStaticLibsResourceJars, dep.TransitiveStaticLibsResourceJars)
1329 }
Colin Cross9055e212024-03-23 04:43:41 +00001330 }
1331 }
1332 addCLCFromDep(ctx, module, a.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00001333 addMissingOptionalUsesLibsFromDep(ctx, module, &a.usesLibrary)
Colin Cross9055e212024-03-23 04:43:41 +00001334 })
1335
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001336 completeStaticLibsHeaderJars := android.NewDepSet(android.PREORDER, android.Paths{classpathFile}, transitiveStaticLibsHeaderJars)
1337 completeStaticLibsImplementationJars := android.NewDepSet(android.PREORDER, android.Paths{classpathFile}, transitiveStaticLibsImplementationJars)
1338 completeStaticLibsResourceJars := android.NewDepSet(android.PREORDER, nil, transitiveStaticLibsResourceJars)
1339
Colin Cross77965d92024-08-15 17:11:08 -07001340 var implementationJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001341 var combineJars android.Paths
1342 if ctx.Config().UseTransitiveJarsInClasspath() {
1343 combineJars = completeStaticLibsImplementationJars.ToList()
1344 } else {
1345 combineJars = append(android.Paths{classpathFile}, staticJars...)
1346 }
1347
1348 if len(combineJars) > 1 {
1349 implementationJarOutputPath := android.PathForModuleOut(ctx, "combined", jarName)
1350 TransformJarsToJar(ctx, implementationJarOutputPath, "combine", combineJars, android.OptionalPath{}, false, nil, nil)
1351 implementationJarFile = implementationJarOutputPath
Colin Cross9055e212024-03-23 04:43:41 +00001352 } else {
Colin Cross28ac2ff2024-04-02 12:21:34 -07001353 implementationJarFile = classpathFile
Colin Cross9055e212024-03-23 04:43:41 +00001354 }
1355
Colin Cross607bbd62024-04-12 13:44:45 -07001356 var resourceJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001357 var resourceJars android.Paths
1358 if ctx.Config().UseTransitiveJarsInClasspath() {
1359 resourceJars = completeStaticLibsResourceJars.ToList()
1360 } else {
1361 resourceJars = staticResourceJars
1362 }
1363 if len(resourceJars) > 1 {
Colin Cross607bbd62024-04-12 13:44:45 -07001364 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001365 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross607bbd62024-04-12 13:44:45 -07001366 false, nil, nil)
1367 resourceJarFile = combinedJar
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001368 } else if len(resourceJars) == 1 {
1369 resourceJarFile = resourceJars[0]
Colin Cross607bbd62024-04-12 13:44:45 -07001370 }
1371
1372 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001373 var implementationAndResourcesJars android.Paths
1374 if ctx.Config().UseTransitiveJarsInClasspath() {
1375 implementationAndResourcesJars = append(slices.Clone(resourceJars), combineJars...)
1376 } else {
1377 implementationAndResourcesJars = android.PathsIfNonNil(resourceJarFile, implementationJarFile)
1378 }
1379 var implementationAndResourcesJar android.Path
1380 if len(implementationAndResourcesJars) > 1 {
Colin Cross77965d92024-08-15 17:11:08 -07001381 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001382 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJars, android.OptionalPath{},
Colin Cross607bbd62024-04-12 13:44:45 -07001383 false, nil, nil)
1384 implementationAndResourcesJar = combinedJar
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001385 } else {
1386 implementationAndResourcesJar = implementationAndResourcesJars[0]
Colin Cross607bbd62024-04-12 13:44:45 -07001387 }
1388
1389 a.implementationJarFile = implementationJarFile
Colin Cross28ac2ff2024-04-02 12:21:34 -07001390 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
Colin Cross607bbd62024-04-12 13:44:45 -07001391 a.implementationAndResourcesJarFile = implementationAndResourcesJar.WithoutRel()
Colin Cross28ac2ff2024-04-02 12:21:34 -07001392
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001393 var headerJars android.Paths
1394 if ctx.Config().UseTransitiveJarsInClasspath() {
1395 headerJars = completeStaticLibsHeaderJars.ToList()
Colin Cross9055e212024-03-23 04:43:41 +00001396 } else {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001397 headerJars = append(android.Paths{classpathFile}, staticHeaderJars...)
1398 }
1399 if len(headerJars) > 1 {
Colin Cross7707b242024-07-26 12:02:36 -07001400 headerJarFile := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001401 TransformJarsToJar(ctx, headerJarFile, "combine header jars", headerJars, android.OptionalPath{}, false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001402 a.headerJarFile = headerJarFile
Colin Cross9055e212024-03-23 04:43:41 +00001403 } else {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001404 a.headerJarFile = headerJars[0]
Colin Cross9055e212024-03-23 04:43:41 +00001405 }
1406
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001407 if ctx.Config().UseTransitiveJarsInClasspath() {
1408 ctx.CheckbuildFile(classpathFile)
1409 } else {
1410 ctx.CheckbuildFile(a.headerJarFile)
1411 ctx.CheckbuildFile(a.implementationJarFile)
1412 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001413
Colin Cross7727c7f2024-07-18 15:36:32 -07001414 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001415 HeaderJars: android.PathsIfNonNil(a.headerJarFile),
1416 LocalHeaderJars: android.PathsIfNonNil(classpathFile),
1417 TransitiveStaticLibsHeaderJars: completeStaticLibsHeaderJars,
1418 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1419 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1420 ResourceJars: android.PathsIfNonNil(resourceJarFile),
1421 TransitiveLibsHeaderJarsForR8: a.transitiveLibsHeaderJarsForR8,
1422 TransitiveStaticLibsHeaderJarsForR8: a.transitiveStaticLibsHeaderJarsForR8,
1423 ImplementationAndResourcesJars: android.PathsIfNonNil(a.implementationAndResourcesJarFile),
1424 ImplementationJars: android.PathsIfNonNil(a.implementationJarFile),
1425 StubsLinkType: Implementation,
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001426 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001427 })
Sam Delmerico82602492022-06-10 17:05:42 +00001428
1429 if proptools.Bool(a.properties.Extract_jni) {
1430 for _, t := range ctx.MultiTargets() {
1431 arch := t.Arch.Abi[0]
1432 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1433 a.jniPackages = append(a.jniPackages, path)
1434
1435 outDir := android.PathForModuleOut(ctx, "aarForJni")
1436 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1437 ctx.Build(pctx, android.BuildParams{
1438 Rule: extractJNI,
1439 Input: aarPath,
1440 Outputs: android.WritablePaths{path},
1441 Description: "extract JNI from AAR",
1442 Args: map[string]string{
1443 "outDir": outDir.String(),
1444 "archString": arch,
1445 },
1446 })
1447 }
Sam Delmerico82602492022-06-10 17:05:42 +00001448 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001449
Colin Cross40213022023-12-13 15:19:49 -08001450 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001451 JniPackages: a.jniPackages,
1452 })
mrziwang68786d82024-07-09 10:41:55 -07001453
1454 ctx.SetOutputFiles([]android.Path{a.implementationAndResourcesJarFile}, "")
1455 ctx.SetOutputFiles([]android.Path{a.aarPath}, ".aar")
Colin Crossdcf71b22021-02-01 13:59:03 -08001456}
Colin Crossfabb6082018-02-20 17:22:23 -08001457
1458func (a *AARImport) HeaderJars() android.Paths {
Colin Cross9055e212024-03-23 04:43:41 +00001459 return android.Paths{a.headerJarFile}
Colin Crossfabb6082018-02-20 17:22:23 -08001460}
1461
Colin Cross331a1212018-08-15 20:40:52 -07001462func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
Colin Cross607bbd62024-04-12 13:44:45 -07001463 return android.Paths{a.implementationAndResourcesJarFile}
Colin Cross331a1212018-08-15 20:40:52 -07001464}
1465
Colin Cross9055e212024-03-23 04:43:41 +00001466func (a *AARImport) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
1467 return OptionalDexJarPath{}
Colin Crossf24a22a2019-01-31 14:12:44 -08001468}
1469
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001470func (a *AARImport) DexJarInstallPath() android.Path {
1471 return nil
1472}
1473
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001474func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Colin Cross9055e212024-03-23 04:43:41 +00001475 return a.classLoaderContexts
Jiyong Park1be96912018-05-28 18:02:19 +09001476}
1477
Colin Cross9055e212024-03-23 04:43:41 +00001478var _ UsesLibraryDependency = (*AARImport)(nil)
1479
Jiyong Park45bf82e2020-12-15 22:29:02 +09001480var _ android.ApexModule = (*AARImport)(nil)
1481
1482// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001483func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1484 return a.depIsInSameApex(ctx, dep)
1485}
1486
Jiyong Park45bf82e2020-12-15 22:29:02 +09001487// Implements android.ApexModule
Colin Cross9055e212024-03-23 04:43:41 +00001488func (a *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
Dan Albertc8060532020-07-22 22:32:17 -07001489 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001490 return nil
1491}
1492
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001493var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001494
Jiakai Zhangf98da192024-04-15 11:15:41 +00001495func (a *AARImport) UsesLibrary() *usesLibrary {
1496 return &a.usesLibrary
1497}
1498
1499var _ ModuleWithUsesLibrary = (*AARImport)(nil)
1500
Colin Cross1b16b0e2019-02-12 14:41:32 -08001501// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1502//
1503// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1504// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001505func AARImportFactory() android.Module {
1506 module := &AARImport{}
1507
Colin Cross9055e212024-03-23 04:43:41 +00001508 module.AddProperties(
1509 &module.properties,
1510 &module.usesLibrary.usesLibraryProperties,
1511 )
Colin Crossfabb6082018-02-20 17:22:23 -08001512
1513 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001514 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001515 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001516 return module
1517}
Spandan Dasb08bf772024-08-07 21:55:42 +00001518
Cole Faustb36d31d2024-08-27 16:04:28 -07001519func (a *AARImport) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb08bf772024-08-07 21:55:42 +00001520 dpInfo.Jars = append(dpInfo.Jars, a.headerJarFile.String(), a.rJar.String())
1521}