blob: ce3d1263cb0de350177d1da06216c0a3682accc2 [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 (
18 "android/soong/android"
Colin Crossa592e3e2019-02-19 16:59:53 -080019 "fmt"
Jaewoong Jung5b425e22019-06-17 17:40:56 -070020 "path/filepath"
Colin Crossa97c5d32018-03-28 14:58:31 -070021 "strings"
Colin Crossfabb6082018-02-20 17:22:23 -080022
23 "github.com/google/blueprint"
Colin Crossa97c5d32018-03-28 14:58:31 -070024 "github.com/google/blueprint/proptools"
Colin Crossfabb6082018-02-20 17:22:23 -080025)
26
Colin Crossa97c5d32018-03-28 14:58:31 -070027type AndroidLibraryDependency interface {
28 Dependency
29 ExportPackage() android.Path
Colin Cross89c31582018-04-30 15:55:11 -070030 ExportedProguardFlagFiles() android.Paths
Anton Hansson53c88442019-03-18 15:53:16 +000031 ExportedRRODirs() []rroDir
Colin Cross66f78822018-05-02 12:58:28 -070032 ExportedStaticPackages() android.Paths
Colin Cross90c25c62019-04-19 16:22:57 -070033 ExportedManifests() android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -070034}
35
36func init() {
37 android.RegisterModuleType("android_library_import", AARImportFactory)
38 android.RegisterModuleType("android_library", AndroidLibraryFactory)
39}
40
41//
42// AAR (android library)
43//
44
45type androidLibraryProperties struct {
46 BuildAAR bool `blueprint:"mutated"`
47}
48
49type aaptProperties struct {
50 // flags passed to aapt when creating the apk
51 Aaptflags []string
52
Dan Willemsen72be5902018-10-24 20:24:57 -070053 // include all resource configurations, not just the product-configured
54 // ones.
55 Aapt_include_all_resources *bool
56
Colin Crossa97c5d32018-03-28 14:58:31 -070057 // list of directories relative to the Blueprints file containing assets.
Colin Cross0ddae7f2019-02-07 15:30:01 -080058 // Defaults to ["assets"] if a directory called assets exists. Set to []
59 // to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070060 Asset_dirs []string
61
62 // list of directories relative to the Blueprints file containing
Colin Cross0ddae7f2019-02-07 15:30:01 -080063 // Android resources. Defaults to ["res"] if a directory called res exists.
64 // Set to [] to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070065 Resource_dirs []string
66
Colin Crossa592e3e2019-02-19 16:59:53 -080067 // list of zip files containing Android resources.
Colin Cross27b922f2019-03-04 22:35:41 -080068 Resource_zips []string `android:"path"`
Colin Crossa592e3e2019-02-19 16:59:53 -080069
Colin Crossa97c5d32018-03-28 14:58:31 -070070 // path to AndroidManifest.xml. If unset, defaults to "AndroidManifest.xml".
Colin Cross27b922f2019-03-04 22:35:41 -080071 Manifest *string `android:"path"`
Colin Crossa97c5d32018-03-28 14:58:31 -070072}
73
74type aapt struct {
Colin Cross90c25c62019-04-19 16:22:57 -070075 aaptSrcJar android.Path
76 exportPackage android.Path
77 manifestPath android.Path
78 transitiveManifestPaths android.Paths
79 proguardOptionsFile android.Path
80 rroDirs []rroDir
81 rTxt android.Path
82 extraAaptPackagesFile android.Path
83 mergedManifestFile android.Path
Jaewoong Jung5b425e22019-06-17 17:40:56 -070084 noticeFile android.OptionalPath
Colin Cross90c25c62019-04-19 16:22:57 -070085 isLibrary bool
Sasha Smundak6ad77252019-05-01 13:16:22 -070086 useEmbeddedNativeLibs bool
Colin Cross90c25c62019-04-19 16:22:57 -070087 useEmbeddedDex bool
88 usesNonSdkApis bool
Colin Cross5446e882019-05-22 10:46:27 -070089 sdkLibraries []string
Jaewoong Jungc27ab662019-05-30 15:51:14 -070090 hasNoCode bool
Colin Crossa97c5d32018-03-28 14:58:31 -070091
Colin Crosse560c4a2019-03-19 16:03:11 -070092 splitNames []string
93 splits []split
94
Colin Crossa97c5d32018-03-28 14:58:31 -070095 aaptProperties aaptProperties
96}
97
Colin Crosse560c4a2019-03-19 16:03:11 -070098type split struct {
99 name string
100 suffix string
101 path android.Path
102}
103
Colin Crossa97c5d32018-03-28 14:58:31 -0700104func (a *aapt) ExportPackage() android.Path {
105 return a.exportPackage
106}
107
Anton Hansson53c88442019-03-18 15:53:16 +0000108func (a *aapt) ExportedRRODirs() []rroDir {
Colin Crossc1c37552019-01-31 11:42:41 -0800109 return a.rroDirs
110}
111
Colin Cross90c25c62019-04-19 16:22:57 -0700112func (a *aapt) ExportedManifests() android.Paths {
113 return a.transitiveManifestPaths
Colin Crossc1c37552019-01-31 11:42:41 -0800114}
115
Colin Crossa0ba2f52019-06-22 12:59:27 -0700116func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext sdkContext,
117 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
118 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700119
120 hasVersionCode := false
121 hasVersionName := false
Colin Crossa97c5d32018-03-28 14:58:31 -0700122 for _, f := range a.aaptProperties.Aaptflags {
123 if strings.HasPrefix(f, "--version-code") {
124 hasVersionCode = true
125 } else if strings.HasPrefix(f, "--version-name") {
126 hasVersionName = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700127 }
128 }
129
Colin Crossa97c5d32018-03-28 14:58:31 -0700130 // Flags specified in Android.bp
131 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
132
133 linkFlags = append(linkFlags, "--no-static-lib-packages")
134
135 // Find implicit or explicit asset and resource dirs
136 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
137 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800138 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700139
Colin Crossa97c5d32018-03-28 14:58:31 -0700140 // Glob directories into lists of paths
141 for _, dir := range resourceDirs {
142 resDirs = append(resDirs, globbedResourceDir{
143 dir: dir,
144 files: androidResourceGlob(ctx, dir),
145 })
146 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, dir)
147 overlayDirs = append(overlayDirs, resOverlayDirs...)
148 rroDirs = append(rroDirs, resRRODirs...)
149 }
150
151 var assetFiles android.Paths
152 for _, dir := range assetDirs {
153 assetFiles = append(assetFiles, androidResourceGlob(ctx, dir)...)
154 }
155
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700156 assetDirStrings := assetDirs.Strings()
157 if a.noticeFile.Valid() {
158 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
159 assetFiles = append(assetFiles, a.noticeFile.Path())
160 }
161
Colin Crossa97c5d32018-03-28 14:58:31 -0700162 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
163 linkDeps = append(linkDeps, manifestPath)
164
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700165 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossa97c5d32018-03-28 14:58:31 -0700166 linkDeps = append(linkDeps, assetFiles...)
167
Colin Crossa97c5d32018-03-28 14:58:31 -0700168 // SDK version flags
Colin Cross83bb3162018-06-25 15:48:06 -0700169 minSdkVersion := sdkVersionOrDefault(ctx, sdkContext.minSdkVersion())
Colin Crossa97c5d32018-03-28 14:58:31 -0700170
Colin Cross83bb3162018-06-25 15:48:06 -0700171 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
172 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700173
Colin Crossa97c5d32018-03-28 14:58:31 -0700174 // Version code
175 if !hasVersionCode {
176 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion())
177 }
178
179 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700180 var versionName string
181 if ctx.ModuleName() == "framework-res" {
182 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
183 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700184 // if it contains the build number. Use the PlatformVersionName instead.
185 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700186 } else {
187 versionName = ctx.Config().AppsDefaultVersionName()
188 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800189 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700190 linkFlags = append(linkFlags, "--version-name ", versionName)
191 }
192
Colin Crossa0ba2f52019-06-22 12:59:27 -0700193 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
194
195 // Always set --pseudo-localize, it will be stripped out later for release
196 // builds that don't want it.
197 compileFlags = append(compileFlags, "--pseudo-localize")
198
199 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700200}
201
Paul Duffin250e6192019-06-07 10:44:37 +0100202func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800203 if sdkDep.frameworkResModule != "" {
204 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700205 }
206}
207
Colin Cross83bb3162018-06-25 15:48:06 -0700208func (a *aapt) buildActions(ctx android.ModuleContext, sdkContext sdkContext, extraLinkFlags ...string) {
Colin Cross5446e882019-05-22 10:46:27 -0700209
210 transitiveStaticLibs, transitiveStaticLibManifests, staticRRODirs, libDeps, libFlags, sdkLibraries :=
211 aaptLibs(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700212
Colin Cross31656952018-05-24 16:11:20 -0700213 // App manifest file
214 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
215 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
216
Colin Cross5446e882019-05-22 10:46:27 -0700217 manifestPath := manifestFixer(ctx, manifestSrcPath, sdkContext, sdkLibraries,
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700218 a.isLibrary, a.useEmbeddedNativeLibs, a.usesNonSdkApis, a.useEmbeddedDex, a.hasNoCode)
Colin Cross90c25c62019-04-19 16:22:57 -0700219
220 a.transitiveManifestPaths = append(android.Paths{manifestPath}, transitiveStaticLibManifests...)
221
222 if len(transitiveStaticLibManifests) > 0 {
Colin Crossaa1c6f12019-04-19 16:25:38 -0700223 a.mergedManifestFile = manifestMerger(ctx, manifestPath, transitiveStaticLibManifests, a.isLibrary)
Colin Cross90c25c62019-04-19 16:22:57 -0700224 if !a.isLibrary {
225 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
226 // will be propagated to the final application and merged there. The merged manifest for libraries is
227 // only passed to Make, which can't handle transitive dependencies.
228 manifestPath = a.mergedManifestFile
229 }
230 } else {
231 a.mergedManifestFile = manifestPath
232 }
Colin Cross31656952018-05-24 16:11:20 -0700233
Colin Crossa0ba2f52019-06-22 12:59:27 -0700234 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700235
Colin Crossc1c37552019-01-31 11:42:41 -0800236 rroDirs = append(rroDirs, staticRRODirs...)
Colin Cross31656952018-05-24 16:11:20 -0700237 linkFlags = append(linkFlags, libFlags...)
238 linkDeps = append(linkDeps, libDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700239 linkFlags = append(linkFlags, extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700240 if a.isLibrary {
241 linkFlags = append(linkFlags, "--static-lib")
242 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700243
244 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
245 srcJar := android.PathForModuleGen(ctx, "R.jar")
246 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
247 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700248 // This file isn't used by Soong, but is generated for exporting
249 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Crossa97c5d32018-03-28 14:58:31 -0700250
Colin Cross4aaa84a2018-08-21 15:14:37 -0700251 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700252 for _, dir := range resDirs {
Colin Crossa0ba2f52019-06-22 12:59:27 -0700253 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700254 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700255
Colin Crossa592e3e2019-02-19 16:59:53 -0800256 for i, zip := range resZips {
257 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700258 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800259 compiledResDirs = append(compiledResDirs, android.Paths{flata})
260 }
261
Colin Cross4aaa84a2018-08-21 15:14:37 -0700262 var compiledRes, compiledOverlay android.Paths
263
264 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
265
Colin Crossbec85302019-02-13 13:15:46 -0800266 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700267 // If we are using static android libraries, every source file becomes an overlay.
268 // This is to emulate old AAPT behavior which simulated library support.
269 for _, compiledResDir := range compiledResDirs {
270 compiledOverlay = append(compiledOverlay, compiledResDir...)
271 }
Colin Crossbec85302019-02-13 13:15:46 -0800272 } else if a.isLibrary {
273 // Otherwise, for a static library we treat all the resources equally with no overlay.
274 for _, compiledResDir := range compiledResDirs {
275 compiledRes = append(compiledRes, compiledResDir...)
276 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700277 } else if len(compiledResDirs) > 0 {
278 // Without static libraries, the first directory is our directory, which can then be
279 // overlaid by the rest.
280 compiledRes = append(compiledRes, compiledResDirs[0]...)
281 for _, compiledResDir := range compiledResDirs[1:] {
282 compiledOverlay = append(compiledOverlay, compiledResDir...)
283 }
284 }
285
Colin Crossa97c5d32018-03-28 14:58:31 -0700286 for _, dir := range overlayDirs {
Colin Crossa0ba2f52019-06-22 12:59:27 -0700287 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700288 }
289
Colin Crosse560c4a2019-03-19 16:03:11 -0700290 var splitPackages android.WritablePaths
291 var splits []split
292
293 for _, s := range a.splitNames {
294 suffix := strings.Replace(s, ",", "_", -1)
295 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
296 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
297 splitPackages = append(splitPackages, path)
298 splits = append(splits, split{
299 name: s,
300 suffix: suffix,
301 path: path,
302 })
303 }
304
Colin Cross66f78822018-05-02 12:58:28 -0700305 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt, extraPackages,
Colin Crosse560c4a2019-03-19 16:03:11 -0700306 linkFlags, linkDeps, compiledRes, compiledOverlay, splitPackages)
Colin Crossa97c5d32018-03-28 14:58:31 -0700307
308 a.aaptSrcJar = srcJar
309 a.exportPackage = packageRes
310 a.manifestPath = manifestPath
311 a.proguardOptionsFile = proguardOptionsFile
312 a.rroDirs = rroDirs
Colin Cross66f78822018-05-02 12:58:28 -0700313 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700314 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700315 a.splits = splits
Colin Crossa97c5d32018-03-28 14:58:31 -0700316}
317
318// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Colin Cross90c25c62019-04-19 16:22:57 -0700319func aaptLibs(ctx android.ModuleContext, sdkContext sdkContext) (transitiveStaticLibs, transitiveStaticLibManifests android.Paths,
Colin Cross5446e882019-05-22 10:46:27 -0700320 staticRRODirs []rroDir, deps android.Paths, flags []string, sdkLibraries []string) {
Colin Cross66f78822018-05-02 12:58:28 -0700321
Colin Crossa97c5d32018-03-28 14:58:31 -0700322 var sharedLibs android.Paths
323
Colin Cross83bb3162018-06-25 15:48:06 -0700324 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700325 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700326 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700327 }
328
329 ctx.VisitDirectDeps(func(module android.Module) {
330 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700331 aarDep, _ := module.(AndroidLibraryDependency)
332 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700333 exportPackage = aarDep.ExportPackage()
334 }
335
336 switch ctx.OtherModuleDependencyTag(module) {
Colin Cross4b964c02018-10-15 16:18:06 -0700337 case instrumentationForTag:
338 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Colin Cross5446e882019-05-22 10:46:27 -0700339 case libTag:
340 if exportPackage != nil {
341 sharedLibs = append(sharedLibs, exportPackage)
342 }
343
344 if _, ok := module.(SdkLibraryDependency); ok {
345 sdkLibraries = append(sdkLibraries, ctx.OtherModuleName(module))
346 }
347
348 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700349 if exportPackage != nil {
350 sharedLibs = append(sharedLibs, exportPackage)
351 }
352 case staticLibTag:
353 if exportPackage != nil {
Colin Cross66f78822018-05-02 12:58:28 -0700354 transitiveStaticLibs = append(transitiveStaticLibs, aarDep.ExportedStaticPackages()...)
Colin Crossbec85302019-02-13 13:15:46 -0800355 transitiveStaticLibs = append(transitiveStaticLibs, exportPackage)
Colin Cross90c25c62019-04-19 16:22:57 -0700356 transitiveStaticLibManifests = append(transitiveStaticLibManifests, aarDep.ExportedManifests()...)
Colin Cross5446e882019-05-22 10:46:27 -0700357 sdkLibraries = append(sdkLibraries, aarDep.ExportedSdkLibs()...)
Anton Hansson53c88442019-03-18 15:53:16 +0000358
359 outer:
360 for _, d := range aarDep.ExportedRRODirs() {
361 for _, e := range staticRRODirs {
362 if d.path == e.path {
363 continue outer
364 }
365 }
366 staticRRODirs = append(staticRRODirs, d)
367 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700368 }
369 }
370 })
371
372 deps = append(deps, sharedLibs...)
Colin Cross66f78822018-05-02 12:58:28 -0700373 deps = append(deps, transitiveStaticLibs...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700374
Colin Cross66f78822018-05-02 12:58:28 -0700375 if len(transitiveStaticLibs) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700376 flags = append(flags, "--auto-add-overlay")
377 }
378
379 for _, sharedLib := range sharedLibs {
380 flags = append(flags, "-I "+sharedLib.String())
381 }
382
Colin Cross66f78822018-05-02 12:58:28 -0700383 transitiveStaticLibs = android.FirstUniquePaths(transitiveStaticLibs)
Colin Cross90c25c62019-04-19 16:22:57 -0700384 transitiveStaticLibManifests = android.FirstUniquePaths(transitiveStaticLibManifests)
Colin Cross5446e882019-05-22 10:46:27 -0700385 sdkLibraries = android.FirstUniqueStrings(sdkLibraries)
Colin Cross66f78822018-05-02 12:58:28 -0700386
Colin Cross5446e882019-05-22 10:46:27 -0700387 return transitiveStaticLibs, transitiveStaticLibManifests, staticRRODirs, deps, flags, sdkLibraries
Colin Crossa97c5d32018-03-28 14:58:31 -0700388}
389
390type AndroidLibrary struct {
391 Library
392 aapt
393
394 androidLibraryProperties androidLibraryProperties
395
396 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700397
398 exportedProguardFlagFiles android.Paths
Colin Cross66f78822018-05-02 12:58:28 -0700399 exportedStaticPackages android.Paths
Colin Cross89c31582018-04-30 15:55:11 -0700400}
401
402func (a *AndroidLibrary) ExportedProguardFlagFiles() android.Paths {
403 return a.exportedProguardFlagFiles
Colin Crossa97c5d32018-03-28 14:58:31 -0700404}
405
Colin Cross66f78822018-05-02 12:58:28 -0700406func (a *AndroidLibrary) ExportedStaticPackages() android.Paths {
407 return a.exportedStaticPackages
408}
409
Colin Crossa97c5d32018-03-28 14:58:31 -0700410var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
411
412func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
413 a.Module.deps(ctx)
Paul Duffin250e6192019-06-07 10:44:37 +0100414 sdkDep := decodeSdkDep(ctx, sdkContext(a))
415 if sdkDep.hasFrameworkLibs() {
416 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700417 }
418}
419
420func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800421 a.aapt.isLibrary = true
Colin Cross5446e882019-05-22 10:46:27 -0700422 a.aapt.sdkLibraries = a.exportedSdkLibs
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700423 a.aapt.buildActions(ctx, sdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -0700424
425 ctx.CheckbuildFile(a.proguardOptionsFile)
426 ctx.CheckbuildFile(a.exportPackage)
427 ctx.CheckbuildFile(a.aaptSrcJar)
428
429 // apps manifests are handled by aapt, don't let Module see them
430 a.properties.Manifest = nil
431
432 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles,
433 a.proguardOptionsFile)
434
435 a.Module.compile(ctx, a.aaptSrcJar)
436
Colin Crossf57c5782019-01-25 13:20:38 -0800437 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700438 var res android.Paths
439 if a.androidLibraryProperties.BuildAAR {
440 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
441 ctx.CheckbuildFile(a.aarFile)
442 }
Colin Cross89c31582018-04-30 15:55:11 -0700443
444 ctx.VisitDirectDeps(func(m android.Module) {
445 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
446 a.exportedProguardFlagFiles = append(a.exportedProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
Colin Cross66f78822018-05-02 12:58:28 -0700447 a.exportedStaticPackages = append(a.exportedStaticPackages, lib.ExportPackage())
448 a.exportedStaticPackages = append(a.exportedStaticPackages, lib.ExportedStaticPackages()...)
Colin Cross89c31582018-04-30 15:55:11 -0700449 }
450 })
451
452 a.exportedProguardFlagFiles = android.FirstUniquePaths(a.exportedProguardFlagFiles)
Colin Cross66f78822018-05-02 12:58:28 -0700453 a.exportedStaticPackages = android.FirstUniquePaths(a.exportedStaticPackages)
Colin Crossa97c5d32018-03-28 14:58:31 -0700454}
455
Colin Cross1b16b0e2019-02-12 14:41:32 -0800456// android_library builds and links sources into a `.jar` file for the device along with Android resources.
457//
458// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
459// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
460// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
461// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700462func AndroidLibraryFactory() android.Module {
463 module := &AndroidLibrary{}
464
465 module.AddProperties(
466 &module.Module.properties,
467 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800468 &module.Module.dexpreoptProperties,
Colin Crossa97c5d32018-03-28 14:58:31 -0700469 &module.Module.protoProperties,
470 &module.aaptProperties,
471 &module.androidLibraryProperties)
472
473 module.androidLibraryProperties.BuildAAR = true
474
Colin Cross48de9a42018-10-02 13:53:33 -0700475 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700476 return module
477}
478
Colin Crossfabb6082018-02-20 17:22:23 -0800479//
480// AAR (android library) prebuilts
481//
Colin Crossfabb6082018-02-20 17:22:23 -0800482
483type AARImportProperties struct {
Colin Cross27b922f2019-03-04 22:35:41 -0800484 Aars []string `android:"path"`
Colin Crossfabb6082018-02-20 17:22:23 -0800485
Colin Cross479884c2018-07-10 13:39:30 -0700486 Sdk_version *string
487 Min_sdk_version *string
Colin Crossa97c5d32018-03-28 14:58:31 -0700488
489 Static_libs []string
490 Libs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -0700491
492 // if set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700493 Jetifier *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800494}
495
496type AARImport struct {
497 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700498 android.DefaultableModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800499 prebuilt android.Prebuilt
500
501 properties AARImportProperties
502
Colin Cross66f78822018-05-02 12:58:28 -0700503 classpathFile android.WritablePath
504 proguardFlags android.WritablePath
505 exportPackage android.WritablePath
506 extraAaptPackagesFile android.WritablePath
Colin Cross10f7c4a2018-05-23 10:59:28 -0700507 manifest android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700508
509 exportedStaticPackages android.Paths
Colin Crossfabb6082018-02-20 17:22:23 -0800510}
511
Colin Cross83bb3162018-06-25 15:48:06 -0700512func (a *AARImport) sdkVersion() string {
Jeongik Cha6bd33c12019-06-25 16:26:18 +0900513 return proptools.StringDefault(a.properties.Sdk_version, defaultSdkVersion(a))
Colin Cross83bb3162018-06-25 15:48:06 -0700514}
515
516func (a *AARImport) minSdkVersion() string {
Colin Cross479884c2018-07-10 13:39:30 -0700517 if a.properties.Min_sdk_version != nil {
518 return *a.properties.Min_sdk_version
519 }
Colin Cross83bb3162018-06-25 15:48:06 -0700520 return a.sdkVersion()
521}
522
Dan Willemsen419290a2018-10-31 15:28:47 -0700523func (a *AARImport) targetSdkVersion() string {
524 return a.sdkVersion()
525}
526
Colin Crossa97c5d32018-03-28 14:58:31 -0700527var _ AndroidLibraryDependency = (*AARImport)(nil)
528
529func (a *AARImport) ExportPackage() android.Path {
530 return a.exportPackage
531}
532
Colin Cross89c31582018-04-30 15:55:11 -0700533func (a *AARImport) ExportedProguardFlagFiles() android.Paths {
534 return android.Paths{a.proguardFlags}
535}
536
Anton Hansson53c88442019-03-18 15:53:16 +0000537func (a *AARImport) ExportedRRODirs() []rroDir {
Colin Crossc1c37552019-01-31 11:42:41 -0800538 return nil
539}
540
Colin Cross66f78822018-05-02 12:58:28 -0700541func (a *AARImport) ExportedStaticPackages() android.Paths {
542 return a.exportedStaticPackages
543}
544
Colin Cross90c25c62019-04-19 16:22:57 -0700545func (a *AARImport) ExportedManifests() android.Paths {
546 return android.Paths{a.manifest}
Colin Cross31656952018-05-24 16:11:20 -0700547}
548
Colin Crossfabb6082018-02-20 17:22:23 -0800549func (a *AARImport) Prebuilt() *android.Prebuilt {
550 return &a.prebuilt
551}
552
553func (a *AARImport) Name() string {
554 return a.prebuilt.Name(a.ModuleBase.Name())
555}
556
557func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross10932872019-04-18 14:27:12 -0700558 if !ctx.Config().UnbundledBuildUsePrebuiltSdks() {
Colin Cross83bb3162018-06-25 15:48:06 -0700559 sdkDep := decodeSdkDep(ctx, sdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -0700560 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -0700561 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -0800562 }
563 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700564
Colin Cross42d48b72018-08-29 14:10:52 -0700565 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
566 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -0800567}
568
569// 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 -0700570// 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 -0800571var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
572 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -0700573 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
574 `unzip -qo -d $outDir $in && rm -rf $outDir/res && touch $out`,
Colin Crossfabb6082018-02-20 17:22:23 -0800575 },
Dan Willemsen304cfec2019-05-28 14:49:06 -0700576 "outDir")
Colin Crossfabb6082018-02-20 17:22:23 -0800577
578func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
579 if len(a.properties.Aars) != 1 {
580 ctx.PropertyErrorf("aars", "exactly one aar is required")
581 return
582 }
583
Nan Zhang4c819fb2018-08-27 18:31:46 -0700584 aarName := ctx.ModuleName() + ".aar"
585 var aar android.Path
586 aar = android.PathForModuleSrc(ctx, a.properties.Aars[0])
Colin Cross1001a792019-03-21 22:21:39 -0700587 if Bool(a.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -0700588 inputFile := aar
589 aar = android.PathForModuleOut(ctx, "jetifier", aarName)
590 TransformJetifier(ctx, aar.(android.WritablePath), inputFile)
591 }
Colin Crossfabb6082018-02-20 17:22:23 -0800592
593 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Crossfabb6082018-02-20 17:22:23 -0800594 a.classpathFile = extractedAARDir.Join(ctx, "classes.jar")
595 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross10f7c4a2018-05-23 10:59:28 -0700596 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossfabb6082018-02-20 17:22:23 -0800597
598 ctx.Build(pctx, android.BuildParams{
599 Rule: unzipAAR,
600 Input: aar,
Colin Cross10f7c4a2018-05-23 10:59:28 -0700601 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest},
Colin Crossfabb6082018-02-20 17:22:23 -0800602 Description: "unzip AAR",
603 Args: map[string]string{
Dan Willemsen304cfec2019-05-28 14:49:06 -0700604 "outDir": extractedAARDir.String(),
Colin Crossfabb6082018-02-20 17:22:23 -0800605 },
606 })
607
Colin Crossa0ba2f52019-06-22 12:59:27 -0700608 // Always set --pseudo-localize, it will be stripped out later for release
609 // builds that don't want it.
610 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -0800611 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -0800612 flata := compiledResDir.Join(ctx, "gen_res.flata")
Colin Crossa0ba2f52019-06-22 12:59:27 -0700613 aapt2CompileZip(ctx, flata, aar, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -0800614
615 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
616 srcJar := android.PathForModuleGen(ctx, "R.jar")
617 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossa97c5d32018-03-28 14:58:31 -0700618 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700619 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -0800620
621 var linkDeps android.Paths
622
623 linkFlags := []string{
624 "--static-lib",
625 "--no-static-lib-packages",
626 "--auto-add-overlay",
627 }
628
Colin Cross10f7c4a2018-05-23 10:59:28 -0700629 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
630 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -0800631
Colin Cross5446e882019-05-22 10:46:27 -0700632 transitiveStaticLibs, staticLibManifests, staticRRODirs, libDeps, libFlags, sdkLibraries :=
633 aaptLibs(ctx, sdkContext(a))
Colin Cross31656952018-05-24 16:11:20 -0700634
635 _ = staticLibManifests
Colin Crossc1c37552019-01-31 11:42:41 -0800636 _ = staticRRODirs
Colin Cross5446e882019-05-22 10:46:27 -0700637 _ = sdkLibraries
Colin Crossfabb6082018-02-20 17:22:23 -0800638
Colin Crossa97c5d32018-03-28 14:58:31 -0700639 linkDeps = append(linkDeps, libDeps...)
640 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -0800641
Colin Cross66f78822018-05-02 12:58:28 -0700642 overlayRes := append(android.Paths{flata}, transitiveStaticLibs...)
Colin Crossfabb6082018-02-20 17:22:23 -0800643
Colin Cross66f78822018-05-02 12:58:28 -0700644 aapt2Link(ctx, a.exportPackage, srcJar, proguardOptionsFile, rTxt, a.extraAaptPackagesFile,
Colin Crosse560c4a2019-03-19 16:03:11 -0700645 linkFlags, linkDeps, nil, overlayRes, nil)
Colin Crossfabb6082018-02-20 17:22:23 -0800646}
647
648var _ Dependency = (*AARImport)(nil)
649
650func (a *AARImport) HeaderJars() android.Paths {
651 return android.Paths{a.classpathFile}
652}
653
654func (a *AARImport) ImplementationJars() android.Paths {
655 return android.Paths{a.classpathFile}
656}
657
Colin Cross331a1212018-08-15 20:40:52 -0700658func (a *AARImport) ResourceJars() android.Paths {
659 return nil
660}
661
662func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
663 return android.Paths{a.classpathFile}
664}
665
Colin Crossf24a22a2019-01-31 14:12:44 -0800666func (a *AARImport) DexJar() android.Path {
667 return nil
668}
669
Colin Crossfabb6082018-02-20 17:22:23 -0800670func (a *AARImport) AidlIncludeDirs() android.Paths {
671 return nil
672}
673
Jiyong Park1be96912018-05-28 18:02:19 +0900674func (a *AARImport) ExportedSdkLibs() []string {
675 return nil
676}
677
Colin Cross0c4ce212019-05-03 15:28:19 -0700678func (a *AARImport) SrcJarArgs() ([]string, android.Paths) {
679 return nil, nil
680}
681
Colin Crossfabb6082018-02-20 17:22:23 -0800682var _ android.PrebuiltInterface = (*Import)(nil)
683
Colin Cross1b16b0e2019-02-12 14:41:32 -0800684// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
685//
686// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
687// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -0800688func AARImportFactory() android.Module {
689 module := &AARImport{}
690
691 module.AddProperties(&module.properties)
692
693 android.InitPrebuiltModule(module, &module.properties.Aars)
Colin Cross48de9a42018-10-02 13:53:33 -0700694 InitJavaModule(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -0800695 return module
696}