blob: d707e36d71c05bc6d7f0e6e7a018a658def62c4f [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 Jung9befb0c2020-01-18 10:33:43 -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
Colin Crossa97c5d32018-03-28 14:58:31 -070035}
36
37func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000038 RegisterAARBuildComponents(android.InitRegistrationContext)
39}
40
41func RegisterAARBuildComponents(ctx android.RegistrationContext) {
42 ctx.RegisterModuleType("android_library_import", AARImportFactory)
43 ctx.RegisterModuleType("android_library", AndroidLibraryFactory)
Colin Crossa97c5d32018-03-28 14:58:31 -070044}
45
46//
47// AAR (android library)
48//
49
50type androidLibraryProperties struct {
51 BuildAAR bool `blueprint:"mutated"`
52}
53
54type aaptProperties struct {
55 // flags passed to aapt when creating the apk
56 Aaptflags []string
57
Dan Willemsen72be5902018-10-24 20:24:57 -070058 // include all resource configurations, not just the product-configured
59 // ones.
60 Aapt_include_all_resources *bool
61
Colin Crossa97c5d32018-03-28 14:58:31 -070062 // list of directories relative to the Blueprints file containing assets.
Colin Cross0ddae7f2019-02-07 15:30:01 -080063 // Defaults to ["assets"] if a directory called assets exists. Set to []
64 // to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070065 Asset_dirs []string
66
67 // list of directories relative to the Blueprints file containing
Colin Cross0ddae7f2019-02-07 15:30:01 -080068 // Android resources. Defaults to ["res"] if a directory called res exists.
69 // Set to [] to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070070 Resource_dirs []string
71
Colin Crossa592e3e2019-02-19 16:59:53 -080072 // list of zip files containing Android resources.
Colin Cross27b922f2019-03-04 22:35:41 -080073 Resource_zips []string `android:"path"`
Colin Crossa592e3e2019-02-19 16:59:53 -080074
Colin Crossa97c5d32018-03-28 14:58:31 -070075 // path to AndroidManifest.xml. If unset, defaults to "AndroidManifest.xml".
Colin Cross27b922f2019-03-04 22:35:41 -080076 Manifest *string `android:"path"`
changho.shinb5432b72019-08-08 18:37:17 +090077
78 // paths to additional manifest files to merge with main manifest.
79 Additional_manifests []string `android:"path"`
Sasha Smundak541056c2019-10-28 15:50:06 -070080
81 // do not include AndroidManifest from dependent libraries
82 Dont_merge_manifests *bool
Colin Crossa97c5d32018-03-28 14:58:31 -070083}
84
85type aapt struct {
Colin Cross90c25c62019-04-19 16:22:57 -070086 aaptSrcJar android.Path
87 exportPackage android.Path
88 manifestPath android.Path
89 transitiveManifestPaths android.Paths
90 proguardOptionsFile android.Path
91 rroDirs []rroDir
92 rTxt android.Path
93 extraAaptPackagesFile android.Path
94 mergedManifestFile android.Path
Jaewoong Jung5b425e22019-06-17 17:40:56 -070095 noticeFile android.OptionalPath
Colin Cross90c25c62019-04-19 16:22:57 -070096 isLibrary bool
Sasha Smundak6ad77252019-05-01 13:16:22 -070097 useEmbeddedNativeLibs bool
Colin Cross90c25c62019-04-19 16:22:57 -070098 useEmbeddedDex bool
99 usesNonSdkApis bool
Colin Cross5446e882019-05-22 10:46:27 -0700100 sdkLibraries []string
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700101 hasNoCode bool
Colin Crossa97c5d32018-03-28 14:58:31 -0700102
Colin Crosse560c4a2019-03-19 16:03:11 -0700103 splitNames []string
104 splits []split
105
Colin Crossa97c5d32018-03-28 14:58:31 -0700106 aaptProperties aaptProperties
107}
108
Colin Crosse560c4a2019-03-19 16:03:11 -0700109type split struct {
110 name string
111 suffix string
112 path android.Path
113}
114
Colin Crossa97c5d32018-03-28 14:58:31 -0700115func (a *aapt) ExportPackage() android.Path {
116 return a.exportPackage
117}
118
Anton Hansson53c88442019-03-18 15:53:16 +0000119func (a *aapt) ExportedRRODirs() []rroDir {
Colin Crossc1c37552019-01-31 11:42:41 -0800120 return a.rroDirs
121}
122
Colin Cross90c25c62019-04-19 16:22:57 -0700123func (a *aapt) ExportedManifests() android.Paths {
124 return a.transitiveManifestPaths
Colin Crossc1c37552019-01-31 11:42:41 -0800125}
126
Colin Crossa0ba2f52019-06-22 12:59:27 -0700127func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext sdkContext,
128 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
129 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700130
131 hasVersionCode := false
132 hasVersionName := false
Colin Crossa97c5d32018-03-28 14:58:31 -0700133 for _, f := range a.aaptProperties.Aaptflags {
134 if strings.HasPrefix(f, "--version-code") {
135 hasVersionCode = true
136 } else if strings.HasPrefix(f, "--version-name") {
137 hasVersionName = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700138 }
139 }
140
Colin Crossa97c5d32018-03-28 14:58:31 -0700141 // Flags specified in Android.bp
142 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
143
144 linkFlags = append(linkFlags, "--no-static-lib-packages")
145
146 // Find implicit or explicit asset and resource dirs
147 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
148 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800149 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700150
Colin Crossa97c5d32018-03-28 14:58:31 -0700151 // Glob directories into lists of paths
152 for _, dir := range resourceDirs {
153 resDirs = append(resDirs, globbedResourceDir{
154 dir: dir,
155 files: androidResourceGlob(ctx, dir),
156 })
157 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, dir)
158 overlayDirs = append(overlayDirs, resOverlayDirs...)
159 rroDirs = append(rroDirs, resRRODirs...)
160 }
161
162 var assetFiles android.Paths
163 for _, dir := range assetDirs {
164 assetFiles = append(assetFiles, androidResourceGlob(ctx, dir)...)
165 }
166
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700167 assetDirStrings := assetDirs.Strings()
168 if a.noticeFile.Valid() {
169 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
170 assetFiles = append(assetFiles, a.noticeFile.Path())
171 }
172
Colin Crossa97c5d32018-03-28 14:58:31 -0700173 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
174 linkDeps = append(linkDeps, manifestPath)
175
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700176 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossa97c5d32018-03-28 14:58:31 -0700177 linkDeps = append(linkDeps, assetFiles...)
178
Colin Crossa97c5d32018-03-28 14:58:31 -0700179 // SDK version flags
Jiyong Park6a927c42020-01-21 02:03:43 +0900180 minSdkVersion, err := sdkContext.minSdkVersion().effectiveVersionString(ctx)
181 if err != nil {
182 ctx.ModuleErrorf("invalid minSdkVersion: %s", err)
183 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700184
Colin Cross83bb3162018-06-25 15:48:06 -0700185 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
186 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700187
Colin Crossa97c5d32018-03-28 14:58:31 -0700188 // Version code
189 if !hasVersionCode {
190 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion())
191 }
192
193 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700194 var versionName string
195 if ctx.ModuleName() == "framework-res" {
196 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
197 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700198 // if it contains the build number. Use the PlatformVersionName instead.
199 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700200 } else {
201 versionName = ctx.Config().AppsDefaultVersionName()
202 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800203 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700204 linkFlags = append(linkFlags, "--version-name ", versionName)
205 }
206
Colin Crossa0ba2f52019-06-22 12:59:27 -0700207 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
208
209 // Always set --pseudo-localize, it will be stripped out later for release
210 // builds that don't want it.
211 compileFlags = append(compileFlags, "--pseudo-localize")
212
213 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700214}
215
Paul Duffin250e6192019-06-07 10:44:37 +0100216func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800217 if sdkDep.frameworkResModule != "" {
218 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700219 }
220}
221
Colin Cross83bb3162018-06-25 15:48:06 -0700222func (a *aapt) buildActions(ctx android.ModuleContext, sdkContext sdkContext, extraLinkFlags ...string) {
Colin Cross5446e882019-05-22 10:46:27 -0700223
224 transitiveStaticLibs, transitiveStaticLibManifests, staticRRODirs, libDeps, libFlags, sdkLibraries :=
225 aaptLibs(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700226
Colin Cross31656952018-05-24 16:11:20 -0700227 // App manifest file
228 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
229 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
230
Colin Cross5446e882019-05-22 10:46:27 -0700231 manifestPath := manifestFixer(ctx, manifestSrcPath, sdkContext, sdkLibraries,
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700232 a.isLibrary, a.useEmbeddedNativeLibs, a.usesNonSdkApis, a.useEmbeddedDex, a.hasNoCode)
Colin Cross90c25c62019-04-19 16:22:57 -0700233
Luca Stefanifd898822019-09-10 22:13:31 +0200234 // Add additional manifest files to transitive manifests.
235 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
236 a.transitiveManifestPaths = append(android.Paths{manifestPath}, additionalManifests...)
237 a.transitiveManifestPaths = append(a.transitiveManifestPaths, transitiveStaticLibManifests...)
Colin Cross90c25c62019-04-19 16:22:57 -0700238
Sasha Smundak541056c2019-10-28 15:50:06 -0700239 if len(a.transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Luca Stefanifd898822019-09-10 22:13:31 +0200240 a.mergedManifestFile = manifestMerger(ctx, a.transitiveManifestPaths[0], a.transitiveManifestPaths[1:], a.isLibrary)
Colin Cross90c25c62019-04-19 16:22:57 -0700241 if !a.isLibrary {
242 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
243 // will be propagated to the final application and merged there. The merged manifest for libraries is
244 // only passed to Make, which can't handle transitive dependencies.
245 manifestPath = a.mergedManifestFile
246 }
247 } else {
248 a.mergedManifestFile = manifestPath
249 }
Colin Cross31656952018-05-24 16:11:20 -0700250
Colin Crossa0ba2f52019-06-22 12:59:27 -0700251 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700252
Colin Crossc1c37552019-01-31 11:42:41 -0800253 rroDirs = append(rroDirs, staticRRODirs...)
Colin Cross31656952018-05-24 16:11:20 -0700254 linkFlags = append(linkFlags, libFlags...)
255 linkDeps = append(linkDeps, libDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700256 linkFlags = append(linkFlags, extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700257 if a.isLibrary {
258 linkFlags = append(linkFlags, "--static-lib")
259 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700260
261 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900262 // the subdir "android" is required to be filtered by package names
263 srcJar := android.PathForModuleGen(ctx, "android", "R.srcjar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700264 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
265 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700266 // This file isn't used by Soong, but is generated for exporting
267 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Crossa97c5d32018-03-28 14:58:31 -0700268
Colin Cross4aaa84a2018-08-21 15:14:37 -0700269 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700270 for _, dir := range resDirs {
Colin Crossa0ba2f52019-06-22 12:59:27 -0700271 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700272 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700273
Colin Crossa592e3e2019-02-19 16:59:53 -0800274 for i, zip := range resZips {
275 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700276 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800277 compiledResDirs = append(compiledResDirs, android.Paths{flata})
278 }
279
Colin Cross4aaa84a2018-08-21 15:14:37 -0700280 var compiledRes, compiledOverlay android.Paths
281
282 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
283
Colin Crossbec85302019-02-13 13:15:46 -0800284 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700285 // If we are using static android libraries, every source file becomes an overlay.
286 // This is to emulate old AAPT behavior which simulated library support.
287 for _, compiledResDir := range compiledResDirs {
288 compiledOverlay = append(compiledOverlay, compiledResDir...)
289 }
Colin Crossbec85302019-02-13 13:15:46 -0800290 } else if a.isLibrary {
291 // Otherwise, for a static library we treat all the resources equally with no overlay.
292 for _, compiledResDir := range compiledResDirs {
293 compiledRes = append(compiledRes, compiledResDir...)
294 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700295 } else if len(compiledResDirs) > 0 {
296 // Without static libraries, the first directory is our directory, which can then be
297 // overlaid by the rest.
298 compiledRes = append(compiledRes, compiledResDirs[0]...)
299 for _, compiledResDir := range compiledResDirs[1:] {
300 compiledOverlay = append(compiledOverlay, compiledResDir...)
301 }
302 }
303
Colin Crossa97c5d32018-03-28 14:58:31 -0700304 for _, dir := range overlayDirs {
Colin Crossa0ba2f52019-06-22 12:59:27 -0700305 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700306 }
307
Colin Crosse560c4a2019-03-19 16:03:11 -0700308 var splitPackages android.WritablePaths
309 var splits []split
310
311 for _, s := range a.splitNames {
312 suffix := strings.Replace(s, ",", "_", -1)
313 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
314 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
315 splitPackages = append(splitPackages, path)
316 splits = append(splits, split{
317 name: s,
318 suffix: suffix,
319 path: path,
320 })
321 }
322
Colin Cross66f78822018-05-02 12:58:28 -0700323 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt, extraPackages,
Colin Crosse560c4a2019-03-19 16:03:11 -0700324 linkFlags, linkDeps, compiledRes, compiledOverlay, splitPackages)
Colin Crossa97c5d32018-03-28 14:58:31 -0700325
326 a.aaptSrcJar = srcJar
327 a.exportPackage = packageRes
328 a.manifestPath = manifestPath
329 a.proguardOptionsFile = proguardOptionsFile
330 a.rroDirs = rroDirs
Colin Cross66f78822018-05-02 12:58:28 -0700331 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700332 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700333 a.splits = splits
Colin Crossa97c5d32018-03-28 14:58:31 -0700334}
335
336// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Colin Cross90c25c62019-04-19 16:22:57 -0700337func aaptLibs(ctx android.ModuleContext, sdkContext sdkContext) (transitiveStaticLibs, transitiveStaticLibManifests android.Paths,
Colin Cross5446e882019-05-22 10:46:27 -0700338 staticRRODirs []rroDir, deps android.Paths, flags []string, sdkLibraries []string) {
Colin Cross66f78822018-05-02 12:58:28 -0700339
Colin Crossa97c5d32018-03-28 14:58:31 -0700340 var sharedLibs android.Paths
341
Colin Cross83bb3162018-06-25 15:48:06 -0700342 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700343 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700344 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700345 }
346
347 ctx.VisitDirectDeps(func(module android.Module) {
348 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700349 aarDep, _ := module.(AndroidLibraryDependency)
350 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700351 exportPackage = aarDep.ExportPackage()
352 }
353
354 switch ctx.OtherModuleDependencyTag(module) {
Colin Cross4b964c02018-10-15 16:18:06 -0700355 case instrumentationForTag:
356 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Colin Cross5446e882019-05-22 10:46:27 -0700357 case libTag:
358 if exportPackage != nil {
359 sharedLibs = append(sharedLibs, exportPackage)
360 }
361
362 if _, ok := module.(SdkLibraryDependency); ok {
363 sdkLibraries = append(sdkLibraries, ctx.OtherModuleName(module))
364 }
365
366 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700367 if exportPackage != nil {
368 sharedLibs = append(sharedLibs, exportPackage)
369 }
370 case staticLibTag:
371 if exportPackage != nil {
Colin Cross66f78822018-05-02 12:58:28 -0700372 transitiveStaticLibs = append(transitiveStaticLibs, aarDep.ExportedStaticPackages()...)
Colin Crossbec85302019-02-13 13:15:46 -0800373 transitiveStaticLibs = append(transitiveStaticLibs, exportPackage)
Colin Cross90c25c62019-04-19 16:22:57 -0700374 transitiveStaticLibManifests = append(transitiveStaticLibManifests, aarDep.ExportedManifests()...)
Colin Cross5446e882019-05-22 10:46:27 -0700375 sdkLibraries = append(sdkLibraries, aarDep.ExportedSdkLibs()...)
Anton Hansson53c88442019-03-18 15:53:16 +0000376
377 outer:
378 for _, d := range aarDep.ExportedRRODirs() {
379 for _, e := range staticRRODirs {
380 if d.path == e.path {
381 continue outer
382 }
383 }
384 staticRRODirs = append(staticRRODirs, d)
385 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700386 }
387 }
388 })
389
390 deps = append(deps, sharedLibs...)
Colin Cross66f78822018-05-02 12:58:28 -0700391 deps = append(deps, transitiveStaticLibs...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700392
Colin Cross66f78822018-05-02 12:58:28 -0700393 if len(transitiveStaticLibs) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700394 flags = append(flags, "--auto-add-overlay")
395 }
396
397 for _, sharedLib := range sharedLibs {
398 flags = append(flags, "-I "+sharedLib.String())
399 }
400
Colin Cross66f78822018-05-02 12:58:28 -0700401 transitiveStaticLibs = android.FirstUniquePaths(transitiveStaticLibs)
Colin Cross90c25c62019-04-19 16:22:57 -0700402 transitiveStaticLibManifests = android.FirstUniquePaths(transitiveStaticLibManifests)
Colin Cross5446e882019-05-22 10:46:27 -0700403 sdkLibraries = android.FirstUniqueStrings(sdkLibraries)
Colin Cross66f78822018-05-02 12:58:28 -0700404
Colin Cross5446e882019-05-22 10:46:27 -0700405 return transitiveStaticLibs, transitiveStaticLibManifests, staticRRODirs, deps, flags, sdkLibraries
Colin Crossa97c5d32018-03-28 14:58:31 -0700406}
407
408type AndroidLibrary struct {
409 Library
410 aapt
411
412 androidLibraryProperties androidLibraryProperties
413
414 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700415
416 exportedProguardFlagFiles android.Paths
Colin Cross66f78822018-05-02 12:58:28 -0700417 exportedStaticPackages android.Paths
Colin Cross89c31582018-04-30 15:55:11 -0700418}
419
420func (a *AndroidLibrary) ExportedProguardFlagFiles() android.Paths {
421 return a.exportedProguardFlagFiles
Colin Crossa97c5d32018-03-28 14:58:31 -0700422}
423
Colin Cross66f78822018-05-02 12:58:28 -0700424func (a *AndroidLibrary) ExportedStaticPackages() android.Paths {
425 return a.exportedStaticPackages
426}
427
Colin Crossa97c5d32018-03-28 14:58:31 -0700428var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
429
430func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
431 a.Module.deps(ctx)
Paul Duffin250e6192019-06-07 10:44:37 +0100432 sdkDep := decodeSdkDep(ctx, sdkContext(a))
433 if sdkDep.hasFrameworkLibs() {
434 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700435 }
436}
437
438func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800439 a.aapt.isLibrary = true
Colin Cross5446e882019-05-22 10:46:27 -0700440 a.aapt.sdkLibraries = a.exportedSdkLibs
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700441 a.aapt.buildActions(ctx, sdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -0700442
443 ctx.CheckbuildFile(a.proguardOptionsFile)
444 ctx.CheckbuildFile(a.exportPackage)
445 ctx.CheckbuildFile(a.aaptSrcJar)
446
447 // apps manifests are handled by aapt, don't let Module see them
448 a.properties.Manifest = nil
449
450 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles,
451 a.proguardOptionsFile)
452
453 a.Module.compile(ctx, a.aaptSrcJar)
454
Colin Crossf57c5782019-01-25 13:20:38 -0800455 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700456 var res android.Paths
457 if a.androidLibraryProperties.BuildAAR {
458 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
459 ctx.CheckbuildFile(a.aarFile)
460 }
Colin Cross89c31582018-04-30 15:55:11 -0700461
462 ctx.VisitDirectDeps(func(m android.Module) {
463 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
464 a.exportedProguardFlagFiles = append(a.exportedProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
Colin Cross66f78822018-05-02 12:58:28 -0700465 a.exportedStaticPackages = append(a.exportedStaticPackages, lib.ExportPackage())
466 a.exportedStaticPackages = append(a.exportedStaticPackages, lib.ExportedStaticPackages()...)
Colin Cross89c31582018-04-30 15:55:11 -0700467 }
468 })
469
470 a.exportedProguardFlagFiles = android.FirstUniquePaths(a.exportedProguardFlagFiles)
Colin Cross66f78822018-05-02 12:58:28 -0700471 a.exportedStaticPackages = android.FirstUniquePaths(a.exportedStaticPackages)
Colin Crossa97c5d32018-03-28 14:58:31 -0700472}
473
Colin Cross1b16b0e2019-02-12 14:41:32 -0800474// android_library builds and links sources into a `.jar` file for the device along with Android resources.
475//
476// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
477// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
478// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
479// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700480func AndroidLibraryFactory() android.Module {
481 module := &AndroidLibrary{}
482
483 module.AddProperties(
484 &module.Module.properties,
485 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800486 &module.Module.dexpreoptProperties,
Colin Crossa97c5d32018-03-28 14:58:31 -0700487 &module.Module.protoProperties,
488 &module.aaptProperties,
489 &module.androidLibraryProperties)
490
491 module.androidLibraryProperties.BuildAAR = true
492
Colin Cross48de9a42018-10-02 13:53:33 -0700493 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700494 return module
495}
496
Colin Crossfabb6082018-02-20 17:22:23 -0800497//
498// AAR (android library) prebuilts
499//
Colin Crossfabb6082018-02-20 17:22:23 -0800500
501type AARImportProperties struct {
Colin Cross27b922f2019-03-04 22:35:41 -0800502 Aars []string `android:"path"`
Colin Crossfabb6082018-02-20 17:22:23 -0800503
Colin Cross479884c2018-07-10 13:39:30 -0700504 Sdk_version *string
505 Min_sdk_version *string
Colin Crossa97c5d32018-03-28 14:58:31 -0700506
507 Static_libs []string
508 Libs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -0700509
510 // if set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700511 Jetifier *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800512}
513
514type AARImport struct {
515 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700516 android.DefaultableModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800517 prebuilt android.Prebuilt
518
519 properties AARImportProperties
520
Colin Cross66f78822018-05-02 12:58:28 -0700521 classpathFile android.WritablePath
522 proguardFlags android.WritablePath
523 exportPackage android.WritablePath
524 extraAaptPackagesFile android.WritablePath
Colin Cross10f7c4a2018-05-23 10:59:28 -0700525 manifest android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700526
527 exportedStaticPackages android.Paths
Colin Crossfabb6082018-02-20 17:22:23 -0800528}
529
Jiyong Park6a927c42020-01-21 02:03:43 +0900530func (a *AARImport) sdkVersion() sdkSpec {
531 return sdkSpecFrom(String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700532}
533
Paul Duffine25c6442019-10-11 13:50:28 +0100534func (a *AARImport) systemModules() string {
535 return ""
536}
537
Jiyong Park6a927c42020-01-21 02:03:43 +0900538func (a *AARImport) minSdkVersion() sdkSpec {
Colin Cross479884c2018-07-10 13:39:30 -0700539 if a.properties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900540 return sdkSpecFrom(*a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -0700541 }
Colin Cross83bb3162018-06-25 15:48:06 -0700542 return a.sdkVersion()
543}
544
Jiyong Park6a927c42020-01-21 02:03:43 +0900545func (a *AARImport) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700546 return a.sdkVersion()
547}
548
Colin Cross1e743852019-10-28 11:37:20 -0700549func (a *AARImport) javaVersion() string {
550 return ""
551}
552
Colin Crossa97c5d32018-03-28 14:58:31 -0700553var _ AndroidLibraryDependency = (*AARImport)(nil)
554
555func (a *AARImport) ExportPackage() android.Path {
556 return a.exportPackage
557}
558
Colin Cross89c31582018-04-30 15:55:11 -0700559func (a *AARImport) ExportedProguardFlagFiles() android.Paths {
560 return android.Paths{a.proguardFlags}
561}
562
Anton Hansson53c88442019-03-18 15:53:16 +0000563func (a *AARImport) ExportedRRODirs() []rroDir {
Colin Crossc1c37552019-01-31 11:42:41 -0800564 return nil
565}
566
Colin Cross66f78822018-05-02 12:58:28 -0700567func (a *AARImport) ExportedStaticPackages() android.Paths {
568 return a.exportedStaticPackages
569}
570
Colin Cross90c25c62019-04-19 16:22:57 -0700571func (a *AARImport) ExportedManifests() android.Paths {
572 return android.Paths{a.manifest}
Colin Cross31656952018-05-24 16:11:20 -0700573}
574
Colin Crossfabb6082018-02-20 17:22:23 -0800575func (a *AARImport) Prebuilt() *android.Prebuilt {
576 return &a.prebuilt
577}
578
579func (a *AARImport) Name() string {
580 return a.prebuilt.Name(a.ModuleBase.Name())
581}
582
Jiyong Park618922e2020-01-08 13:35:43 +0900583func (a *AARImport) JacocoReportClassesFile() android.Path {
584 return nil
585}
586
Colin Crossfabb6082018-02-20 17:22:23 -0800587func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross10932872019-04-18 14:27:12 -0700588 if !ctx.Config().UnbundledBuildUsePrebuiltSdks() {
Colin Cross83bb3162018-06-25 15:48:06 -0700589 sdkDep := decodeSdkDep(ctx, sdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -0700590 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -0700591 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -0800592 }
593 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700594
Colin Cross42d48b72018-08-29 14:10:52 -0700595 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
596 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -0800597}
598
599// 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 -0700600// 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 -0800601var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
602 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -0700603 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
604 `unzip -qo -d $outDir $in && rm -rf $outDir/res && touch $out`,
Colin Crossfabb6082018-02-20 17:22:23 -0800605 },
Dan Willemsen304cfec2019-05-28 14:49:06 -0700606 "outDir")
Colin Crossfabb6082018-02-20 17:22:23 -0800607
608func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
609 if len(a.properties.Aars) != 1 {
610 ctx.PropertyErrorf("aars", "exactly one aar is required")
611 return
612 }
613
Nan Zhang4c819fb2018-08-27 18:31:46 -0700614 aarName := ctx.ModuleName() + ".aar"
615 var aar android.Path
616 aar = android.PathForModuleSrc(ctx, a.properties.Aars[0])
Colin Cross1001a792019-03-21 22:21:39 -0700617 if Bool(a.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -0700618 inputFile := aar
619 aar = android.PathForModuleOut(ctx, "jetifier", aarName)
620 TransformJetifier(ctx, aar.(android.WritablePath), inputFile)
621 }
Colin Crossfabb6082018-02-20 17:22:23 -0800622
623 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Crossfabb6082018-02-20 17:22:23 -0800624 a.classpathFile = extractedAARDir.Join(ctx, "classes.jar")
625 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross10f7c4a2018-05-23 10:59:28 -0700626 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossfabb6082018-02-20 17:22:23 -0800627
628 ctx.Build(pctx, android.BuildParams{
629 Rule: unzipAAR,
630 Input: aar,
Colin Cross10f7c4a2018-05-23 10:59:28 -0700631 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest},
Colin Crossfabb6082018-02-20 17:22:23 -0800632 Description: "unzip AAR",
633 Args: map[string]string{
Dan Willemsen304cfec2019-05-28 14:49:06 -0700634 "outDir": extractedAARDir.String(),
Colin Crossfabb6082018-02-20 17:22:23 -0800635 },
636 })
637
Colin Crossa0ba2f52019-06-22 12:59:27 -0700638 // Always set --pseudo-localize, it will be stripped out later for release
639 // builds that don't want it.
640 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -0800641 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -0800642 flata := compiledResDir.Join(ctx, "gen_res.flata")
Colin Crossa0ba2f52019-06-22 12:59:27 -0700643 aapt2CompileZip(ctx, flata, aar, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -0800644
645 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900646 // the subdir "android" is required to be filtered by package names
647 srcJar := android.PathForModuleGen(ctx, "android", "R.srcjar")
Colin Crossfabb6082018-02-20 17:22:23 -0800648 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossa97c5d32018-03-28 14:58:31 -0700649 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700650 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -0800651
652 var linkDeps android.Paths
653
654 linkFlags := []string{
655 "--static-lib",
656 "--no-static-lib-packages",
657 "--auto-add-overlay",
658 }
659
Colin Cross10f7c4a2018-05-23 10:59:28 -0700660 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
661 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -0800662
Colin Cross5446e882019-05-22 10:46:27 -0700663 transitiveStaticLibs, staticLibManifests, staticRRODirs, libDeps, libFlags, sdkLibraries :=
664 aaptLibs(ctx, sdkContext(a))
Colin Cross31656952018-05-24 16:11:20 -0700665
666 _ = staticLibManifests
Colin Crossc1c37552019-01-31 11:42:41 -0800667 _ = staticRRODirs
Colin Cross5446e882019-05-22 10:46:27 -0700668 _ = sdkLibraries
Colin Crossfabb6082018-02-20 17:22:23 -0800669
Colin Crossa97c5d32018-03-28 14:58:31 -0700670 linkDeps = append(linkDeps, libDeps...)
671 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -0800672
Colin Cross66f78822018-05-02 12:58:28 -0700673 overlayRes := append(android.Paths{flata}, transitiveStaticLibs...)
Colin Crossfabb6082018-02-20 17:22:23 -0800674
Colin Cross66f78822018-05-02 12:58:28 -0700675 aapt2Link(ctx, a.exportPackage, srcJar, proguardOptionsFile, rTxt, a.extraAaptPackagesFile,
Colin Crosse560c4a2019-03-19 16:03:11 -0700676 linkFlags, linkDeps, nil, overlayRes, nil)
Colin Crossfabb6082018-02-20 17:22:23 -0800677}
678
679var _ Dependency = (*AARImport)(nil)
680
681func (a *AARImport) HeaderJars() android.Paths {
682 return android.Paths{a.classpathFile}
683}
684
685func (a *AARImport) ImplementationJars() android.Paths {
686 return android.Paths{a.classpathFile}
687}
688
Colin Cross331a1212018-08-15 20:40:52 -0700689func (a *AARImport) ResourceJars() android.Paths {
690 return nil
691}
692
693func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
694 return android.Paths{a.classpathFile}
695}
696
Colin Crossf24a22a2019-01-31 14:12:44 -0800697func (a *AARImport) DexJar() android.Path {
698 return nil
699}
700
Colin Crossfabb6082018-02-20 17:22:23 -0800701func (a *AARImport) AidlIncludeDirs() android.Paths {
702 return nil
703}
704
Jiyong Park1be96912018-05-28 18:02:19 +0900705func (a *AARImport) ExportedSdkLibs() []string {
706 return nil
707}
708
Artur Satayev9cf46692019-11-26 18:08:34 +0000709func (d *AARImport) ExportedPlugins() (android.Paths, []string) {
710 return nil, nil
711}
712
Colin Cross0c4ce212019-05-03 15:28:19 -0700713func (a *AARImport) SrcJarArgs() ([]string, android.Paths) {
714 return nil, nil
715}
716
Colin Crossfabb6082018-02-20 17:22:23 -0800717var _ android.PrebuiltInterface = (*Import)(nil)
718
Colin Cross1b16b0e2019-02-12 14:41:32 -0800719// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
720//
721// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
722// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -0800723func AARImportFactory() android.Module {
724 module := &AARImport{}
725
726 module.AddProperties(&module.properties)
727
728 android.InitPrebuiltModule(module, &module.properties.Aars)
Colin Cross48de9a42018-10-02 13:53:33 -0700729 InitJavaModule(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -0800730 return module
731}