blob: c0b39b678ee67abaebd3e515d4cd6b2ff14e08f7 [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 Crossa97c5d32018-03-28 14:58:31 -070020 "strings"
Colin Crossfabb6082018-02-20 17:22:23 -080021
Jaewoong Jung6431ca72020-01-15 14:15:10 -080022 "android/soong/android"
23
Colin Crossfabb6082018-02-20 17:22:23 -080024 "github.com/google/blueprint"
Colin Crossa97c5d32018-03-28 14:58:31 -070025 "github.com/google/blueprint/proptools"
Colin Crossfabb6082018-02-20 17:22:23 -080026)
27
Colin Crossa97c5d32018-03-28 14:58:31 -070028type AndroidLibraryDependency interface {
29 Dependency
30 ExportPackage() android.Path
Colin Cross89c31582018-04-30 15:55:11 -070031 ExportedProguardFlagFiles() android.Paths
Anton Hansson53c88442019-03-18 15:53:16 +000032 ExportedRRODirs() []rroDir
Colin Cross66f78822018-05-02 12:58:28 -070033 ExportedStaticPackages() android.Paths
Colin Cross90c25c62019-04-19 16:22:57 -070034 ExportedManifests() android.Paths
Jaewoong Jung6431ca72020-01-15 14:15:10 -080035 ExportedAssets() android.OptionalPath
Colin Crossa97c5d32018-03-28 14:58:31 -070036}
37
38func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000039 RegisterAARBuildComponents(android.InitRegistrationContext)
40}
41
42func RegisterAARBuildComponents(ctx android.RegistrationContext) {
43 ctx.RegisterModuleType("android_library_import", AARImportFactory)
44 ctx.RegisterModuleType("android_library", AndroidLibraryFactory)
Colin Crossa97c5d32018-03-28 14:58:31 -070045}
46
47//
48// AAR (android library)
49//
50
51type androidLibraryProperties struct {
52 BuildAAR bool `blueprint:"mutated"`
53}
54
55type aaptProperties struct {
56 // flags passed to aapt when creating the apk
57 Aaptflags []string
58
Dan Willemsen72be5902018-10-24 20:24:57 -070059 // include all resource configurations, not just the product-configured
60 // ones.
61 Aapt_include_all_resources *bool
62
Colin Crossa97c5d32018-03-28 14:58:31 -070063 // list of directories relative to the Blueprints file containing assets.
Colin Cross0ddae7f2019-02-07 15:30:01 -080064 // Defaults to ["assets"] if a directory called assets exists. Set to []
65 // to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070066 Asset_dirs []string
67
68 // list of directories relative to the Blueprints file containing
Colin Cross0ddae7f2019-02-07 15:30:01 -080069 // Android resources. Defaults to ["res"] if a directory called res exists.
70 // Set to [] to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070071 Resource_dirs []string
72
Colin Crossa592e3e2019-02-19 16:59:53 -080073 // list of zip files containing Android resources.
Colin Cross27b922f2019-03-04 22:35:41 -080074 Resource_zips []string `android:"path"`
Colin Crossa592e3e2019-02-19 16:59:53 -080075
Colin Crossa97c5d32018-03-28 14:58:31 -070076 // path to AndroidManifest.xml. If unset, defaults to "AndroidManifest.xml".
Colin Cross27b922f2019-03-04 22:35:41 -080077 Manifest *string `android:"path"`
changho.shinb5432b72019-08-08 18:37:17 +090078
79 // paths to additional manifest files to merge with main manifest.
80 Additional_manifests []string `android:"path"`
Sasha Smundak541056c2019-10-28 15:50:06 -070081
82 // do not include AndroidManifest from dependent libraries
83 Dont_merge_manifests *bool
Colin Crossa97c5d32018-03-28 14:58:31 -070084}
85
86type aapt struct {
Colin Cross90c25c62019-04-19 16:22:57 -070087 aaptSrcJar android.Path
88 exportPackage android.Path
89 manifestPath android.Path
90 transitiveManifestPaths android.Paths
91 proguardOptionsFile android.Path
92 rroDirs []rroDir
93 rTxt android.Path
94 extraAaptPackagesFile android.Path
95 mergedManifestFile android.Path
Jaewoong Jung5b425e22019-06-17 17:40:56 -070096 noticeFile android.OptionalPath
Jaewoong Jung6431ca72020-01-15 14:15:10 -080097 assetPackage android.OptionalPath
Colin Cross90c25c62019-04-19 16:22:57 -070098 isLibrary bool
Sasha Smundak6ad77252019-05-01 13:16:22 -070099 useEmbeddedNativeLibs bool
Colin Cross90c25c62019-04-19 16:22:57 -0700100 useEmbeddedDex bool
101 usesNonSdkApis bool
Colin Cross5446e882019-05-22 10:46:27 -0700102 sdkLibraries []string
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700103 hasNoCode bool
Colin Crossa97c5d32018-03-28 14:58:31 -0700104
Colin Crosse560c4a2019-03-19 16:03:11 -0700105 splitNames []string
106 splits []split
107
Colin Crossa97c5d32018-03-28 14:58:31 -0700108 aaptProperties aaptProperties
109}
110
Colin Crosse560c4a2019-03-19 16:03:11 -0700111type split struct {
112 name string
113 suffix string
114 path android.Path
115}
116
Colin Crossa97c5d32018-03-28 14:58:31 -0700117func (a *aapt) ExportPackage() android.Path {
118 return a.exportPackage
119}
120
Anton Hansson53c88442019-03-18 15:53:16 +0000121func (a *aapt) ExportedRRODirs() []rroDir {
Colin Crossc1c37552019-01-31 11:42:41 -0800122 return a.rroDirs
123}
124
Colin Cross90c25c62019-04-19 16:22:57 -0700125func (a *aapt) ExportedManifests() android.Paths {
126 return a.transitiveManifestPaths
Colin Crossc1c37552019-01-31 11:42:41 -0800127}
128
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800129func (a *aapt) ExportedAssets() android.OptionalPath {
130 return a.assetPackage
131}
132
Colin Crossa0ba2f52019-06-22 12:59:27 -0700133func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext sdkContext,
134 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
135 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700136
137 hasVersionCode := false
138 hasVersionName := false
Colin Crossa97c5d32018-03-28 14:58:31 -0700139 for _, f := range a.aaptProperties.Aaptflags {
140 if strings.HasPrefix(f, "--version-code") {
141 hasVersionCode = true
142 } else if strings.HasPrefix(f, "--version-name") {
143 hasVersionName = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700144 }
145 }
146
Colin Crossa97c5d32018-03-28 14:58:31 -0700147 // Flags specified in Android.bp
148 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
149
150 linkFlags = append(linkFlags, "--no-static-lib-packages")
151
152 // Find implicit or explicit asset and resource dirs
153 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
154 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800155 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700156
Colin Crossa97c5d32018-03-28 14:58:31 -0700157 // Glob directories into lists of paths
158 for _, dir := range resourceDirs {
159 resDirs = append(resDirs, globbedResourceDir{
160 dir: dir,
161 files: androidResourceGlob(ctx, dir),
162 })
163 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, dir)
164 overlayDirs = append(overlayDirs, resOverlayDirs...)
165 rroDirs = append(rroDirs, resRRODirs...)
166 }
167
168 var assetFiles android.Paths
169 for _, dir := range assetDirs {
170 assetFiles = append(assetFiles, androidResourceGlob(ctx, dir)...)
171 }
172
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700173 assetDirStrings := assetDirs.Strings()
174 if a.noticeFile.Valid() {
175 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
176 assetFiles = append(assetFiles, a.noticeFile.Path())
177 }
178
Colin Crossa97c5d32018-03-28 14:58:31 -0700179 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
180 linkDeps = append(linkDeps, manifestPath)
181
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700182 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossa97c5d32018-03-28 14:58:31 -0700183 linkDeps = append(linkDeps, assetFiles...)
184
Colin Crossa97c5d32018-03-28 14:58:31 -0700185 // SDK version flags
Colin Cross83bb3162018-06-25 15:48:06 -0700186 minSdkVersion := sdkVersionOrDefault(ctx, sdkContext.minSdkVersion())
Colin Crossa97c5d32018-03-28 14:58:31 -0700187
Colin Cross83bb3162018-06-25 15:48:06 -0700188 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
189 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700190
Colin Crossa97c5d32018-03-28 14:58:31 -0700191 // Version code
192 if !hasVersionCode {
193 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion())
194 }
195
196 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700197 var versionName string
198 if ctx.ModuleName() == "framework-res" {
199 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
200 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700201 // if it contains the build number. Use the PlatformVersionName instead.
202 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700203 } else {
204 versionName = ctx.Config().AppsDefaultVersionName()
205 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800206 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700207 linkFlags = append(linkFlags, "--version-name ", versionName)
208 }
209
Colin Crossa0ba2f52019-06-22 12:59:27 -0700210 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
211
212 // Always set --pseudo-localize, it will be stripped out later for release
213 // builds that don't want it.
214 compileFlags = append(compileFlags, "--pseudo-localize")
215
216 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700217}
218
Paul Duffin250e6192019-06-07 10:44:37 +0100219func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800220 if sdkDep.frameworkResModule != "" {
221 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700222 }
223}
224
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800225var extractAssetsRule = pctx.AndroidStaticRule("extractAssets",
226 blueprint.RuleParams{
227 Command: `${config.Zip2ZipCmd} -i ${in} -o ${out} "assets/**/*"`,
228 CommandDeps: []string{"${config.Zip2ZipCmd}"},
229 })
230
Colin Cross83bb3162018-06-25 15:48:06 -0700231func (a *aapt) buildActions(ctx android.ModuleContext, sdkContext sdkContext, extraLinkFlags ...string) {
Colin Cross5446e882019-05-22 10:46:27 -0700232
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800233 transitiveStaticLibs, transitiveStaticLibManifests, staticRRODirs, assetPackages, libDeps, libFlags, sdkLibraries :=
Colin Cross5446e882019-05-22 10:46:27 -0700234 aaptLibs(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700235
Colin Cross31656952018-05-24 16:11:20 -0700236 // App manifest file
237 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
238 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
239
Colin Cross5446e882019-05-22 10:46:27 -0700240 manifestPath := manifestFixer(ctx, manifestSrcPath, sdkContext, sdkLibraries,
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700241 a.isLibrary, a.useEmbeddedNativeLibs, a.usesNonSdkApis, a.useEmbeddedDex, a.hasNoCode)
Colin Cross90c25c62019-04-19 16:22:57 -0700242
Luca Stefanifd898822019-09-10 22:13:31 +0200243 // Add additional manifest files to transitive manifests.
244 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
245 a.transitiveManifestPaths = append(android.Paths{manifestPath}, additionalManifests...)
246 a.transitiveManifestPaths = append(a.transitiveManifestPaths, transitiveStaticLibManifests...)
Colin Cross90c25c62019-04-19 16:22:57 -0700247
Sasha Smundak541056c2019-10-28 15:50:06 -0700248 if len(a.transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Luca Stefanifd898822019-09-10 22:13:31 +0200249 a.mergedManifestFile = manifestMerger(ctx, a.transitiveManifestPaths[0], a.transitiveManifestPaths[1:], a.isLibrary)
Colin Cross90c25c62019-04-19 16:22:57 -0700250 if !a.isLibrary {
251 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
252 // will be propagated to the final application and merged there. The merged manifest for libraries is
253 // only passed to Make, which can't handle transitive dependencies.
254 manifestPath = a.mergedManifestFile
255 }
256 } else {
257 a.mergedManifestFile = manifestPath
258 }
Colin Cross31656952018-05-24 16:11:20 -0700259
Colin Crossa0ba2f52019-06-22 12:59:27 -0700260 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700261
Colin Crossc1c37552019-01-31 11:42:41 -0800262 rroDirs = append(rroDirs, staticRRODirs...)
Colin Cross31656952018-05-24 16:11:20 -0700263 linkFlags = append(linkFlags, libFlags...)
264 linkDeps = append(linkDeps, libDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700265 linkFlags = append(linkFlags, extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700266 if a.isLibrary {
267 linkFlags = append(linkFlags, "--static-lib")
268 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700269
270 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900271 // the subdir "android" is required to be filtered by package names
272 srcJar := android.PathForModuleGen(ctx, "android", "R.srcjar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700273 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
274 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700275 // This file isn't used by Soong, but is generated for exporting
276 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Crossa97c5d32018-03-28 14:58:31 -0700277
Colin Cross4aaa84a2018-08-21 15:14:37 -0700278 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700279 for _, dir := range resDirs {
Colin Crossa0ba2f52019-06-22 12:59:27 -0700280 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700281 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700282
Colin Crossa592e3e2019-02-19 16:59:53 -0800283 for i, zip := range resZips {
284 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700285 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800286 compiledResDirs = append(compiledResDirs, android.Paths{flata})
287 }
288
Colin Cross4aaa84a2018-08-21 15:14:37 -0700289 var compiledRes, compiledOverlay android.Paths
290
291 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
292
Colin Crossbec85302019-02-13 13:15:46 -0800293 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700294 // If we are using static android libraries, every source file becomes an overlay.
295 // This is to emulate old AAPT behavior which simulated library support.
296 for _, compiledResDir := range compiledResDirs {
297 compiledOverlay = append(compiledOverlay, compiledResDir...)
298 }
Colin Crossbec85302019-02-13 13:15:46 -0800299 } else if a.isLibrary {
300 // Otherwise, for a static library we treat all the resources equally with no overlay.
301 for _, compiledResDir := range compiledResDirs {
302 compiledRes = append(compiledRes, compiledResDir...)
303 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700304 } else if len(compiledResDirs) > 0 {
305 // Without static libraries, the first directory is our directory, which can then be
306 // overlaid by the rest.
307 compiledRes = append(compiledRes, compiledResDirs[0]...)
308 for _, compiledResDir := range compiledResDirs[1:] {
309 compiledOverlay = append(compiledOverlay, compiledResDir...)
310 }
311 }
312
Colin Crossa97c5d32018-03-28 14:58:31 -0700313 for _, dir := range overlayDirs {
Colin Crossa0ba2f52019-06-22 12:59:27 -0700314 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700315 }
316
Colin Crosse560c4a2019-03-19 16:03:11 -0700317 var splitPackages android.WritablePaths
318 var splits []split
319
320 for _, s := range a.splitNames {
321 suffix := strings.Replace(s, ",", "_", -1)
322 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
323 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
324 splitPackages = append(splitPackages, path)
325 splits = append(splits, split{
326 name: s,
327 suffix: suffix,
328 path: path,
329 })
330 }
331
Colin Cross66f78822018-05-02 12:58:28 -0700332 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt, extraPackages,
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800333 linkFlags, linkDeps, compiledRes, compiledOverlay, assetPackages, splitPackages)
334
335 // Extract assets from the resource package output so that they can be used later in aapt2link
336 // for modules that depend on this one.
337 if android.PrefixedStringInList(linkFlags, "-A ") || len(assetPackages) > 0 {
338 assets := android.PathForModuleOut(ctx, "assets.zip")
339 ctx.Build(pctx, android.BuildParams{
340 Rule: extractAssetsRule,
341 Input: packageRes,
342 Output: assets,
343 Description: "extract assets from built resource file",
344 })
345 a.assetPackage = android.OptionalPathForPath(assets)
346 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700347
348 a.aaptSrcJar = srcJar
349 a.exportPackage = packageRes
350 a.manifestPath = manifestPath
351 a.proguardOptionsFile = proguardOptionsFile
352 a.rroDirs = rroDirs
Colin Cross66f78822018-05-02 12:58:28 -0700353 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700354 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700355 a.splits = splits
Colin Crossa97c5d32018-03-28 14:58:31 -0700356}
357
358// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Colin Cross90c25c62019-04-19 16:22:57 -0700359func aaptLibs(ctx android.ModuleContext, sdkContext sdkContext) (transitiveStaticLibs, transitiveStaticLibManifests android.Paths,
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800360 staticRRODirs []rroDir, assets, deps android.Paths, flags []string, sdkLibraries []string) {
Colin Cross66f78822018-05-02 12:58:28 -0700361
Colin Crossa97c5d32018-03-28 14:58:31 -0700362 var sharedLibs android.Paths
363
Colin Cross83bb3162018-06-25 15:48:06 -0700364 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700365 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700366 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700367 }
368
369 ctx.VisitDirectDeps(func(module android.Module) {
370 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700371 aarDep, _ := module.(AndroidLibraryDependency)
372 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700373 exportPackage = aarDep.ExportPackage()
374 }
375
376 switch ctx.OtherModuleDependencyTag(module) {
Colin Cross4b964c02018-10-15 16:18:06 -0700377 case instrumentationForTag:
378 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Colin Cross5446e882019-05-22 10:46:27 -0700379 case libTag:
380 if exportPackage != nil {
381 sharedLibs = append(sharedLibs, exportPackage)
382 }
383
384 if _, ok := module.(SdkLibraryDependency); ok {
385 sdkLibraries = append(sdkLibraries, ctx.OtherModuleName(module))
386 }
387
388 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700389 if exportPackage != nil {
390 sharedLibs = append(sharedLibs, exportPackage)
391 }
392 case staticLibTag:
393 if exportPackage != nil {
Colin Cross66f78822018-05-02 12:58:28 -0700394 transitiveStaticLibs = append(transitiveStaticLibs, aarDep.ExportedStaticPackages()...)
Colin Crossbec85302019-02-13 13:15:46 -0800395 transitiveStaticLibs = append(transitiveStaticLibs, exportPackage)
Colin Cross90c25c62019-04-19 16:22:57 -0700396 transitiveStaticLibManifests = append(transitiveStaticLibManifests, aarDep.ExportedManifests()...)
Colin Cross5446e882019-05-22 10:46:27 -0700397 sdkLibraries = append(sdkLibraries, aarDep.ExportedSdkLibs()...)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800398 if aarDep.ExportedAssets().Valid() {
399 assets = append(assets, aarDep.ExportedAssets().Path())
400 }
Anton Hansson53c88442019-03-18 15:53:16 +0000401
402 outer:
403 for _, d := range aarDep.ExportedRRODirs() {
404 for _, e := range staticRRODirs {
405 if d.path == e.path {
406 continue outer
407 }
408 }
409 staticRRODirs = append(staticRRODirs, d)
410 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700411 }
412 }
413 })
414
415 deps = append(deps, sharedLibs...)
Colin Cross66f78822018-05-02 12:58:28 -0700416 deps = append(deps, transitiveStaticLibs...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700417
Colin Cross66f78822018-05-02 12:58:28 -0700418 if len(transitiveStaticLibs) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700419 flags = append(flags, "--auto-add-overlay")
420 }
421
422 for _, sharedLib := range sharedLibs {
423 flags = append(flags, "-I "+sharedLib.String())
424 }
425
Colin Cross66f78822018-05-02 12:58:28 -0700426 transitiveStaticLibs = android.FirstUniquePaths(transitiveStaticLibs)
Colin Cross90c25c62019-04-19 16:22:57 -0700427 transitiveStaticLibManifests = android.FirstUniquePaths(transitiveStaticLibManifests)
Colin Cross5446e882019-05-22 10:46:27 -0700428 sdkLibraries = android.FirstUniqueStrings(sdkLibraries)
Colin Cross66f78822018-05-02 12:58:28 -0700429
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800430 return transitiveStaticLibs, transitiveStaticLibManifests, staticRRODirs, assets, deps, flags, sdkLibraries
Colin Crossa97c5d32018-03-28 14:58:31 -0700431}
432
433type AndroidLibrary struct {
434 Library
435 aapt
436
437 androidLibraryProperties androidLibraryProperties
438
439 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700440
441 exportedProguardFlagFiles android.Paths
Colin Cross66f78822018-05-02 12:58:28 -0700442 exportedStaticPackages android.Paths
Colin Cross89c31582018-04-30 15:55:11 -0700443}
444
445func (a *AndroidLibrary) ExportedProguardFlagFiles() android.Paths {
446 return a.exportedProguardFlagFiles
Colin Crossa97c5d32018-03-28 14:58:31 -0700447}
448
Colin Cross66f78822018-05-02 12:58:28 -0700449func (a *AndroidLibrary) ExportedStaticPackages() android.Paths {
450 return a.exportedStaticPackages
451}
452
Colin Crossa97c5d32018-03-28 14:58:31 -0700453var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
454
455func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
456 a.Module.deps(ctx)
Paul Duffin250e6192019-06-07 10:44:37 +0100457 sdkDep := decodeSdkDep(ctx, sdkContext(a))
458 if sdkDep.hasFrameworkLibs() {
459 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700460 }
461}
462
463func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800464 a.aapt.isLibrary = true
Colin Cross5446e882019-05-22 10:46:27 -0700465 a.aapt.sdkLibraries = a.exportedSdkLibs
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700466 a.aapt.buildActions(ctx, sdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -0700467
468 ctx.CheckbuildFile(a.proguardOptionsFile)
469 ctx.CheckbuildFile(a.exportPackage)
470 ctx.CheckbuildFile(a.aaptSrcJar)
471
472 // apps manifests are handled by aapt, don't let Module see them
473 a.properties.Manifest = nil
474
475 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles,
476 a.proguardOptionsFile)
477
478 a.Module.compile(ctx, a.aaptSrcJar)
479
Colin Crossf57c5782019-01-25 13:20:38 -0800480 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700481 var res android.Paths
482 if a.androidLibraryProperties.BuildAAR {
483 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
484 ctx.CheckbuildFile(a.aarFile)
485 }
Colin Cross89c31582018-04-30 15:55:11 -0700486
487 ctx.VisitDirectDeps(func(m android.Module) {
488 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
489 a.exportedProguardFlagFiles = append(a.exportedProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
Colin Cross66f78822018-05-02 12:58:28 -0700490 a.exportedStaticPackages = append(a.exportedStaticPackages, lib.ExportPackage())
491 a.exportedStaticPackages = append(a.exportedStaticPackages, lib.ExportedStaticPackages()...)
Colin Cross89c31582018-04-30 15:55:11 -0700492 }
493 })
494
495 a.exportedProguardFlagFiles = android.FirstUniquePaths(a.exportedProguardFlagFiles)
Colin Cross66f78822018-05-02 12:58:28 -0700496 a.exportedStaticPackages = android.FirstUniquePaths(a.exportedStaticPackages)
Colin Crossa97c5d32018-03-28 14:58:31 -0700497}
498
Colin Cross1b16b0e2019-02-12 14:41:32 -0800499// android_library builds and links sources into a `.jar` file for the device along with Android resources.
500//
501// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
502// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
503// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
504// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700505func AndroidLibraryFactory() android.Module {
506 module := &AndroidLibrary{}
507
508 module.AddProperties(
509 &module.Module.properties,
510 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800511 &module.Module.dexpreoptProperties,
Colin Crossa97c5d32018-03-28 14:58:31 -0700512 &module.Module.protoProperties,
513 &module.aaptProperties,
514 &module.androidLibraryProperties)
515
516 module.androidLibraryProperties.BuildAAR = true
517
Colin Cross48de9a42018-10-02 13:53:33 -0700518 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700519 return module
520}
521
Colin Crossfabb6082018-02-20 17:22:23 -0800522//
523// AAR (android library) prebuilts
524//
Colin Crossfabb6082018-02-20 17:22:23 -0800525
526type AARImportProperties struct {
Colin Cross27b922f2019-03-04 22:35:41 -0800527 Aars []string `android:"path"`
Colin Crossfabb6082018-02-20 17:22:23 -0800528
Colin Cross479884c2018-07-10 13:39:30 -0700529 Sdk_version *string
530 Min_sdk_version *string
Colin Crossa97c5d32018-03-28 14:58:31 -0700531
532 Static_libs []string
533 Libs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -0700534
535 // if set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700536 Jetifier *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800537}
538
539type AARImport struct {
540 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700541 android.DefaultableModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800542 prebuilt android.Prebuilt
543
544 properties AARImportProperties
545
Colin Cross66f78822018-05-02 12:58:28 -0700546 classpathFile android.WritablePath
547 proguardFlags android.WritablePath
548 exportPackage android.WritablePath
549 extraAaptPackagesFile android.WritablePath
Colin Cross10f7c4a2018-05-23 10:59:28 -0700550 manifest android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700551
552 exportedStaticPackages android.Paths
Colin Crossfabb6082018-02-20 17:22:23 -0800553}
554
Colin Cross83bb3162018-06-25 15:48:06 -0700555func (a *AARImport) sdkVersion() string {
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900556 return String(a.properties.Sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700557}
558
Paul Duffine25c6442019-10-11 13:50:28 +0100559func (a *AARImport) systemModules() string {
560 return ""
561}
562
Colin Cross83bb3162018-06-25 15:48:06 -0700563func (a *AARImport) minSdkVersion() string {
Colin Cross479884c2018-07-10 13:39:30 -0700564 if a.properties.Min_sdk_version != nil {
565 return *a.properties.Min_sdk_version
566 }
Colin Cross83bb3162018-06-25 15:48:06 -0700567 return a.sdkVersion()
568}
569
Dan Willemsen419290a2018-10-31 15:28:47 -0700570func (a *AARImport) targetSdkVersion() string {
571 return a.sdkVersion()
572}
573
Colin Cross1e743852019-10-28 11:37:20 -0700574func (a *AARImport) javaVersion() string {
575 return ""
576}
577
Colin Crossa97c5d32018-03-28 14:58:31 -0700578var _ AndroidLibraryDependency = (*AARImport)(nil)
579
580func (a *AARImport) ExportPackage() android.Path {
581 return a.exportPackage
582}
583
Colin Cross89c31582018-04-30 15:55:11 -0700584func (a *AARImport) ExportedProguardFlagFiles() android.Paths {
585 return android.Paths{a.proguardFlags}
586}
587
Anton Hansson53c88442019-03-18 15:53:16 +0000588func (a *AARImport) ExportedRRODirs() []rroDir {
Colin Crossc1c37552019-01-31 11:42:41 -0800589 return nil
590}
591
Colin Cross66f78822018-05-02 12:58:28 -0700592func (a *AARImport) ExportedStaticPackages() android.Paths {
593 return a.exportedStaticPackages
594}
595
Colin Cross90c25c62019-04-19 16:22:57 -0700596func (a *AARImport) ExportedManifests() android.Paths {
597 return android.Paths{a.manifest}
Colin Cross31656952018-05-24 16:11:20 -0700598}
599
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800600// TODO(jungjw): Decide whether we want to implement this.
601func (a *AARImport) ExportedAssets() android.OptionalPath {
602 return android.OptionalPath{}
603}
604
Colin Crossfabb6082018-02-20 17:22:23 -0800605func (a *AARImport) Prebuilt() *android.Prebuilt {
606 return &a.prebuilt
607}
608
609func (a *AARImport) Name() string {
610 return a.prebuilt.Name(a.ModuleBase.Name())
611}
612
Jiyong Park618922e2020-01-08 13:35:43 +0900613func (a *AARImport) JacocoReportClassesFile() android.Path {
614 return nil
615}
616
Colin Crossfabb6082018-02-20 17:22:23 -0800617func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross10932872019-04-18 14:27:12 -0700618 if !ctx.Config().UnbundledBuildUsePrebuiltSdks() {
Colin Cross83bb3162018-06-25 15:48:06 -0700619 sdkDep := decodeSdkDep(ctx, sdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -0700620 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -0700621 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -0800622 }
623 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700624
Colin Cross42d48b72018-08-29 14:10:52 -0700625 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
626 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -0800627}
628
629// 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 -0700630// 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 -0800631var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
632 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -0700633 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
634 `unzip -qo -d $outDir $in && rm -rf $outDir/res && touch $out`,
Colin Crossfabb6082018-02-20 17:22:23 -0800635 },
Dan Willemsen304cfec2019-05-28 14:49:06 -0700636 "outDir")
Colin Crossfabb6082018-02-20 17:22:23 -0800637
638func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
639 if len(a.properties.Aars) != 1 {
640 ctx.PropertyErrorf("aars", "exactly one aar is required")
641 return
642 }
643
Nan Zhang4c819fb2018-08-27 18:31:46 -0700644 aarName := ctx.ModuleName() + ".aar"
645 var aar android.Path
646 aar = android.PathForModuleSrc(ctx, a.properties.Aars[0])
Colin Cross1001a792019-03-21 22:21:39 -0700647 if Bool(a.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -0700648 inputFile := aar
649 aar = android.PathForModuleOut(ctx, "jetifier", aarName)
650 TransformJetifier(ctx, aar.(android.WritablePath), inputFile)
651 }
Colin Crossfabb6082018-02-20 17:22:23 -0800652
653 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Crossfabb6082018-02-20 17:22:23 -0800654 a.classpathFile = extractedAARDir.Join(ctx, "classes.jar")
655 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross10f7c4a2018-05-23 10:59:28 -0700656 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossfabb6082018-02-20 17:22:23 -0800657
658 ctx.Build(pctx, android.BuildParams{
659 Rule: unzipAAR,
660 Input: aar,
Colin Cross10f7c4a2018-05-23 10:59:28 -0700661 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest},
Colin Crossfabb6082018-02-20 17:22:23 -0800662 Description: "unzip AAR",
663 Args: map[string]string{
Dan Willemsen304cfec2019-05-28 14:49:06 -0700664 "outDir": extractedAARDir.String(),
Colin Crossfabb6082018-02-20 17:22:23 -0800665 },
666 })
667
Colin Crossa0ba2f52019-06-22 12:59:27 -0700668 // Always set --pseudo-localize, it will be stripped out later for release
669 // builds that don't want it.
670 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -0800671 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -0800672 flata := compiledResDir.Join(ctx, "gen_res.flata")
Colin Crossa0ba2f52019-06-22 12:59:27 -0700673 aapt2CompileZip(ctx, flata, aar, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -0800674
675 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900676 // the subdir "android" is required to be filtered by package names
677 srcJar := android.PathForModuleGen(ctx, "android", "R.srcjar")
Colin Crossfabb6082018-02-20 17:22:23 -0800678 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossa97c5d32018-03-28 14:58:31 -0700679 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700680 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -0800681
682 var linkDeps android.Paths
683
684 linkFlags := []string{
685 "--static-lib",
686 "--no-static-lib-packages",
687 "--auto-add-overlay",
688 }
689
Colin Cross10f7c4a2018-05-23 10:59:28 -0700690 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
691 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -0800692
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800693 transitiveStaticLibs, staticLibManifests, staticRRODirs, transitiveAssets, libDeps, libFlags, sdkLibraries :=
Colin Cross5446e882019-05-22 10:46:27 -0700694 aaptLibs(ctx, sdkContext(a))
Colin Cross31656952018-05-24 16:11:20 -0700695
696 _ = staticLibManifests
Colin Crossc1c37552019-01-31 11:42:41 -0800697 _ = staticRRODirs
Colin Cross5446e882019-05-22 10:46:27 -0700698 _ = sdkLibraries
Colin Crossfabb6082018-02-20 17:22:23 -0800699
Colin Crossa97c5d32018-03-28 14:58:31 -0700700 linkDeps = append(linkDeps, libDeps...)
701 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -0800702
Colin Cross66f78822018-05-02 12:58:28 -0700703 overlayRes := append(android.Paths{flata}, transitiveStaticLibs...)
Colin Crossfabb6082018-02-20 17:22:23 -0800704
Colin Cross66f78822018-05-02 12:58:28 -0700705 aapt2Link(ctx, a.exportPackage, srcJar, proguardOptionsFile, rTxt, a.extraAaptPackagesFile,
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800706 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil)
Colin Crossfabb6082018-02-20 17:22:23 -0800707}
708
709var _ Dependency = (*AARImport)(nil)
710
711func (a *AARImport) HeaderJars() android.Paths {
712 return android.Paths{a.classpathFile}
713}
714
715func (a *AARImport) ImplementationJars() android.Paths {
716 return android.Paths{a.classpathFile}
717}
718
Colin Cross331a1212018-08-15 20:40:52 -0700719func (a *AARImport) ResourceJars() android.Paths {
720 return nil
721}
722
723func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
724 return android.Paths{a.classpathFile}
725}
726
Colin Crossf24a22a2019-01-31 14:12:44 -0800727func (a *AARImport) DexJar() android.Path {
728 return nil
729}
730
Colin Crossfabb6082018-02-20 17:22:23 -0800731func (a *AARImport) AidlIncludeDirs() android.Paths {
732 return nil
733}
734
Jiyong Park1be96912018-05-28 18:02:19 +0900735func (a *AARImport) ExportedSdkLibs() []string {
736 return nil
737}
738
Artur Satayev9cf46692019-11-26 18:08:34 +0000739func (d *AARImport) ExportedPlugins() (android.Paths, []string) {
740 return nil, nil
741}
742
Colin Cross0c4ce212019-05-03 15:28:19 -0700743func (a *AARImport) SrcJarArgs() ([]string, android.Paths) {
744 return nil, nil
745}
746
Colin Crossfabb6082018-02-20 17:22:23 -0800747var _ android.PrebuiltInterface = (*Import)(nil)
748
Colin Cross1b16b0e2019-02-12 14:41:32 -0800749// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
750//
751// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
752// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -0800753func AARImportFactory() android.Module {
754 module := &AARImport{}
755
756 module.AddProperties(&module.properties)
757
758 android.InitPrebuiltModule(module, &module.properties.Aars)
Colin Cross48de9a42018-10-02 13:53:33 -0700759 InitJavaModule(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -0800760 return module
761}