blob: f5d7e976192f122716b9eee512d73e5debe50846 [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"`
changho.shinb5432b72019-08-08 18:37:17 +090072
73 // paths to additional manifest files to merge with main manifest.
74 Additional_manifests []string `android:"path"`
Colin Crossa97c5d32018-03-28 14:58:31 -070075}
76
77type aapt struct {
Colin Cross90c25c62019-04-19 16:22:57 -070078 aaptSrcJar android.Path
79 exportPackage android.Path
80 manifestPath android.Path
81 transitiveManifestPaths android.Paths
82 proguardOptionsFile android.Path
83 rroDirs []rroDir
84 rTxt android.Path
85 extraAaptPackagesFile android.Path
86 mergedManifestFile android.Path
Jaewoong Jung5b425e22019-06-17 17:40:56 -070087 noticeFile android.OptionalPath
Colin Cross90c25c62019-04-19 16:22:57 -070088 isLibrary bool
Sasha Smundak6ad77252019-05-01 13:16:22 -070089 useEmbeddedNativeLibs bool
Colin Cross90c25c62019-04-19 16:22:57 -070090 useEmbeddedDex bool
91 usesNonSdkApis bool
Colin Cross5446e882019-05-22 10:46:27 -070092 sdkLibraries []string
Jaewoong Jungc27ab662019-05-30 15:51:14 -070093 hasNoCode bool
Colin Crossa97c5d32018-03-28 14:58:31 -070094
Colin Crosse560c4a2019-03-19 16:03:11 -070095 splitNames []string
96 splits []split
97
Colin Crossa97c5d32018-03-28 14:58:31 -070098 aaptProperties aaptProperties
99}
100
Colin Crosse560c4a2019-03-19 16:03:11 -0700101type split struct {
102 name string
103 suffix string
104 path android.Path
105}
106
Colin Crossa97c5d32018-03-28 14:58:31 -0700107func (a *aapt) ExportPackage() android.Path {
108 return a.exportPackage
109}
110
Anton Hansson53c88442019-03-18 15:53:16 +0000111func (a *aapt) ExportedRRODirs() []rroDir {
Colin Crossc1c37552019-01-31 11:42:41 -0800112 return a.rroDirs
113}
114
Colin Cross90c25c62019-04-19 16:22:57 -0700115func (a *aapt) ExportedManifests() android.Paths {
116 return a.transitiveManifestPaths
Colin Crossc1c37552019-01-31 11:42:41 -0800117}
118
Colin Crossa0ba2f52019-06-22 12:59:27 -0700119func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext sdkContext,
120 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
121 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700122
123 hasVersionCode := false
124 hasVersionName := false
Colin Crossa97c5d32018-03-28 14:58:31 -0700125 for _, f := range a.aaptProperties.Aaptflags {
126 if strings.HasPrefix(f, "--version-code") {
127 hasVersionCode = true
128 } else if strings.HasPrefix(f, "--version-name") {
129 hasVersionName = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700130 }
131 }
132
Colin Crossa97c5d32018-03-28 14:58:31 -0700133 // Flags specified in Android.bp
134 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
135
136 linkFlags = append(linkFlags, "--no-static-lib-packages")
137
138 // Find implicit or explicit asset and resource dirs
139 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
140 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800141 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700142
Colin Crossa97c5d32018-03-28 14:58:31 -0700143 // Glob directories into lists of paths
144 for _, dir := range resourceDirs {
145 resDirs = append(resDirs, globbedResourceDir{
146 dir: dir,
147 files: androidResourceGlob(ctx, dir),
148 })
149 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, dir)
150 overlayDirs = append(overlayDirs, resOverlayDirs...)
151 rroDirs = append(rroDirs, resRRODirs...)
152 }
153
154 var assetFiles android.Paths
155 for _, dir := range assetDirs {
156 assetFiles = append(assetFiles, androidResourceGlob(ctx, dir)...)
157 }
158
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700159 assetDirStrings := assetDirs.Strings()
160 if a.noticeFile.Valid() {
161 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
162 assetFiles = append(assetFiles, a.noticeFile.Path())
163 }
164
Colin Crossa97c5d32018-03-28 14:58:31 -0700165 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
166 linkDeps = append(linkDeps, manifestPath)
167
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700168 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossa97c5d32018-03-28 14:58:31 -0700169 linkDeps = append(linkDeps, assetFiles...)
170
Colin Crossa97c5d32018-03-28 14:58:31 -0700171 // SDK version flags
Colin Cross83bb3162018-06-25 15:48:06 -0700172 minSdkVersion := sdkVersionOrDefault(ctx, sdkContext.minSdkVersion())
Colin Crossa97c5d32018-03-28 14:58:31 -0700173
Colin Cross83bb3162018-06-25 15:48:06 -0700174 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
175 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700176
Colin Crossa97c5d32018-03-28 14:58:31 -0700177 // Version code
178 if !hasVersionCode {
179 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion())
180 }
181
182 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700183 var versionName string
184 if ctx.ModuleName() == "framework-res" {
185 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
186 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700187 // if it contains the build number. Use the PlatformVersionName instead.
188 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700189 } else {
190 versionName = ctx.Config().AppsDefaultVersionName()
191 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800192 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700193 linkFlags = append(linkFlags, "--version-name ", versionName)
194 }
195
Colin Crossa0ba2f52019-06-22 12:59:27 -0700196 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
197
198 // Always set --pseudo-localize, it will be stripped out later for release
199 // builds that don't want it.
200 compileFlags = append(compileFlags, "--pseudo-localize")
201
202 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700203}
204
Paul Duffin250e6192019-06-07 10:44:37 +0100205func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800206 if sdkDep.frameworkResModule != "" {
207 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700208 }
209}
210
Colin Cross83bb3162018-06-25 15:48:06 -0700211func (a *aapt) buildActions(ctx android.ModuleContext, sdkContext sdkContext, extraLinkFlags ...string) {
Colin Cross5446e882019-05-22 10:46:27 -0700212
213 transitiveStaticLibs, transitiveStaticLibManifests, staticRRODirs, libDeps, libFlags, sdkLibraries :=
214 aaptLibs(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700215
Colin Cross31656952018-05-24 16:11:20 -0700216 // App manifest file
217 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
218 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
219
Colin Cross5446e882019-05-22 10:46:27 -0700220 manifestPath := manifestFixer(ctx, manifestSrcPath, sdkContext, sdkLibraries,
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700221 a.isLibrary, a.useEmbeddedNativeLibs, a.usesNonSdkApis, a.useEmbeddedDex, a.hasNoCode)
Colin Cross90c25c62019-04-19 16:22:57 -0700222
223 a.transitiveManifestPaths = append(android.Paths{manifestPath}, transitiveStaticLibManifests...)
224
225 if len(transitiveStaticLibManifests) > 0 {
changho.shinb5432b72019-08-08 18:37:17 +0900226 // Merge additional manifest files with app manifest.
227 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
228 additionalManifests = append(additionalManifests, transitiveStaticLibManifests...)
229
230 a.mergedManifestFile = manifestMerger(ctx, manifestPath, additionalManifests, a.isLibrary)
Colin Cross90c25c62019-04-19 16:22:57 -0700231 if !a.isLibrary {
232 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
233 // will be propagated to the final application and merged there. The merged manifest for libraries is
234 // only passed to Make, which can't handle transitive dependencies.
235 manifestPath = a.mergedManifestFile
236 }
237 } else {
238 a.mergedManifestFile = manifestPath
239 }
Colin Cross31656952018-05-24 16:11:20 -0700240
Colin Crossa0ba2f52019-06-22 12:59:27 -0700241 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700242
Colin Crossc1c37552019-01-31 11:42:41 -0800243 rroDirs = append(rroDirs, staticRRODirs...)
Colin Cross31656952018-05-24 16:11:20 -0700244 linkFlags = append(linkFlags, libFlags...)
245 linkDeps = append(linkDeps, libDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700246 linkFlags = append(linkFlags, extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700247 if a.isLibrary {
248 linkFlags = append(linkFlags, "--static-lib")
249 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700250
251 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900252 // the subdir "android" is required to be filtered by package names
253 srcJar := android.PathForModuleGen(ctx, "android", "R.srcjar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700254 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
255 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700256 // This file isn't used by Soong, but is generated for exporting
257 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Crossa97c5d32018-03-28 14:58:31 -0700258
Colin Cross4aaa84a2018-08-21 15:14:37 -0700259 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700260 for _, dir := range resDirs {
Colin Crossa0ba2f52019-06-22 12:59:27 -0700261 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700262 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700263
Colin Crossa592e3e2019-02-19 16:59:53 -0800264 for i, zip := range resZips {
265 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700266 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800267 compiledResDirs = append(compiledResDirs, android.Paths{flata})
268 }
269
Colin Cross4aaa84a2018-08-21 15:14:37 -0700270 var compiledRes, compiledOverlay android.Paths
271
272 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
273
Colin Crossbec85302019-02-13 13:15:46 -0800274 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700275 // If we are using static android libraries, every source file becomes an overlay.
276 // This is to emulate old AAPT behavior which simulated library support.
277 for _, compiledResDir := range compiledResDirs {
278 compiledOverlay = append(compiledOverlay, compiledResDir...)
279 }
Colin Crossbec85302019-02-13 13:15:46 -0800280 } else if a.isLibrary {
281 // Otherwise, for a static library we treat all the resources equally with no overlay.
282 for _, compiledResDir := range compiledResDirs {
283 compiledRes = append(compiledRes, compiledResDir...)
284 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700285 } else if len(compiledResDirs) > 0 {
286 // Without static libraries, the first directory is our directory, which can then be
287 // overlaid by the rest.
288 compiledRes = append(compiledRes, compiledResDirs[0]...)
289 for _, compiledResDir := range compiledResDirs[1:] {
290 compiledOverlay = append(compiledOverlay, compiledResDir...)
291 }
292 }
293
Colin Crossa97c5d32018-03-28 14:58:31 -0700294 for _, dir := range overlayDirs {
Colin Crossa0ba2f52019-06-22 12:59:27 -0700295 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700296 }
297
Colin Crosse560c4a2019-03-19 16:03:11 -0700298 var splitPackages android.WritablePaths
299 var splits []split
300
301 for _, s := range a.splitNames {
302 suffix := strings.Replace(s, ",", "_", -1)
303 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
304 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
305 splitPackages = append(splitPackages, path)
306 splits = append(splits, split{
307 name: s,
308 suffix: suffix,
309 path: path,
310 })
311 }
312
Colin Cross66f78822018-05-02 12:58:28 -0700313 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt, extraPackages,
Colin Crosse560c4a2019-03-19 16:03:11 -0700314 linkFlags, linkDeps, compiledRes, compiledOverlay, splitPackages)
Colin Crossa97c5d32018-03-28 14:58:31 -0700315
316 a.aaptSrcJar = srcJar
317 a.exportPackage = packageRes
318 a.manifestPath = manifestPath
319 a.proguardOptionsFile = proguardOptionsFile
320 a.rroDirs = rroDirs
Colin Cross66f78822018-05-02 12:58:28 -0700321 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700322 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700323 a.splits = splits
Colin Crossa97c5d32018-03-28 14:58:31 -0700324}
325
326// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Colin Cross90c25c62019-04-19 16:22:57 -0700327func aaptLibs(ctx android.ModuleContext, sdkContext sdkContext) (transitiveStaticLibs, transitiveStaticLibManifests android.Paths,
Colin Cross5446e882019-05-22 10:46:27 -0700328 staticRRODirs []rroDir, deps android.Paths, flags []string, sdkLibraries []string) {
Colin Cross66f78822018-05-02 12:58:28 -0700329
Colin Crossa97c5d32018-03-28 14:58:31 -0700330 var sharedLibs android.Paths
331
Colin Cross83bb3162018-06-25 15:48:06 -0700332 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700333 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700334 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700335 }
336
337 ctx.VisitDirectDeps(func(module android.Module) {
338 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700339 aarDep, _ := module.(AndroidLibraryDependency)
340 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700341 exportPackage = aarDep.ExportPackage()
342 }
343
344 switch ctx.OtherModuleDependencyTag(module) {
Colin Cross4b964c02018-10-15 16:18:06 -0700345 case instrumentationForTag:
346 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Colin Cross5446e882019-05-22 10:46:27 -0700347 case libTag:
348 if exportPackage != nil {
349 sharedLibs = append(sharedLibs, exportPackage)
350 }
351
352 if _, ok := module.(SdkLibraryDependency); ok {
353 sdkLibraries = append(sdkLibraries, ctx.OtherModuleName(module))
354 }
355
356 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700357 if exportPackage != nil {
358 sharedLibs = append(sharedLibs, exportPackage)
359 }
360 case staticLibTag:
361 if exportPackage != nil {
Colin Cross66f78822018-05-02 12:58:28 -0700362 transitiveStaticLibs = append(transitiveStaticLibs, aarDep.ExportedStaticPackages()...)
Colin Crossbec85302019-02-13 13:15:46 -0800363 transitiveStaticLibs = append(transitiveStaticLibs, exportPackage)
Colin Cross90c25c62019-04-19 16:22:57 -0700364 transitiveStaticLibManifests = append(transitiveStaticLibManifests, aarDep.ExportedManifests()...)
Colin Cross5446e882019-05-22 10:46:27 -0700365 sdkLibraries = append(sdkLibraries, aarDep.ExportedSdkLibs()...)
Anton Hansson53c88442019-03-18 15:53:16 +0000366
367 outer:
368 for _, d := range aarDep.ExportedRRODirs() {
369 for _, e := range staticRRODirs {
370 if d.path == e.path {
371 continue outer
372 }
373 }
374 staticRRODirs = append(staticRRODirs, d)
375 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700376 }
377 }
378 })
379
380 deps = append(deps, sharedLibs...)
Colin Cross66f78822018-05-02 12:58:28 -0700381 deps = append(deps, transitiveStaticLibs...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700382
Colin Cross66f78822018-05-02 12:58:28 -0700383 if len(transitiveStaticLibs) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700384 flags = append(flags, "--auto-add-overlay")
385 }
386
387 for _, sharedLib := range sharedLibs {
388 flags = append(flags, "-I "+sharedLib.String())
389 }
390
Colin Cross66f78822018-05-02 12:58:28 -0700391 transitiveStaticLibs = android.FirstUniquePaths(transitiveStaticLibs)
Colin Cross90c25c62019-04-19 16:22:57 -0700392 transitiveStaticLibManifests = android.FirstUniquePaths(transitiveStaticLibManifests)
Colin Cross5446e882019-05-22 10:46:27 -0700393 sdkLibraries = android.FirstUniqueStrings(sdkLibraries)
Colin Cross66f78822018-05-02 12:58:28 -0700394
Colin Cross5446e882019-05-22 10:46:27 -0700395 return transitiveStaticLibs, transitiveStaticLibManifests, staticRRODirs, deps, flags, sdkLibraries
Colin Crossa97c5d32018-03-28 14:58:31 -0700396}
397
398type AndroidLibrary struct {
399 Library
400 aapt
401
402 androidLibraryProperties androidLibraryProperties
403
404 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700405
406 exportedProguardFlagFiles android.Paths
Colin Cross66f78822018-05-02 12:58:28 -0700407 exportedStaticPackages android.Paths
Colin Cross89c31582018-04-30 15:55:11 -0700408}
409
410func (a *AndroidLibrary) ExportedProguardFlagFiles() android.Paths {
411 return a.exportedProguardFlagFiles
Colin Crossa97c5d32018-03-28 14:58:31 -0700412}
413
Colin Cross66f78822018-05-02 12:58:28 -0700414func (a *AndroidLibrary) ExportedStaticPackages() android.Paths {
415 return a.exportedStaticPackages
416}
417
Colin Crossa97c5d32018-03-28 14:58:31 -0700418var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
419
420func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
421 a.Module.deps(ctx)
Paul Duffin250e6192019-06-07 10:44:37 +0100422 sdkDep := decodeSdkDep(ctx, sdkContext(a))
423 if sdkDep.hasFrameworkLibs() {
424 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700425 }
426}
427
428func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800429 a.aapt.isLibrary = true
Colin Cross5446e882019-05-22 10:46:27 -0700430 a.aapt.sdkLibraries = a.exportedSdkLibs
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700431 a.aapt.buildActions(ctx, sdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -0700432
433 ctx.CheckbuildFile(a.proguardOptionsFile)
434 ctx.CheckbuildFile(a.exportPackage)
435 ctx.CheckbuildFile(a.aaptSrcJar)
436
437 // apps manifests are handled by aapt, don't let Module see them
438 a.properties.Manifest = nil
439
440 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles,
441 a.proguardOptionsFile)
442
443 a.Module.compile(ctx, a.aaptSrcJar)
444
Colin Crossf57c5782019-01-25 13:20:38 -0800445 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700446 var res android.Paths
447 if a.androidLibraryProperties.BuildAAR {
448 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
449 ctx.CheckbuildFile(a.aarFile)
450 }
Colin Cross89c31582018-04-30 15:55:11 -0700451
452 ctx.VisitDirectDeps(func(m android.Module) {
453 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
454 a.exportedProguardFlagFiles = append(a.exportedProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
Colin Cross66f78822018-05-02 12:58:28 -0700455 a.exportedStaticPackages = append(a.exportedStaticPackages, lib.ExportPackage())
456 a.exportedStaticPackages = append(a.exportedStaticPackages, lib.ExportedStaticPackages()...)
Colin Cross89c31582018-04-30 15:55:11 -0700457 }
458 })
459
460 a.exportedProguardFlagFiles = android.FirstUniquePaths(a.exportedProguardFlagFiles)
Colin Cross66f78822018-05-02 12:58:28 -0700461 a.exportedStaticPackages = android.FirstUniquePaths(a.exportedStaticPackages)
Colin Crossa97c5d32018-03-28 14:58:31 -0700462}
463
Colin Cross1b16b0e2019-02-12 14:41:32 -0800464// android_library builds and links sources into a `.jar` file for the device along with Android resources.
465//
466// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
467// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
468// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
469// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700470func AndroidLibraryFactory() android.Module {
471 module := &AndroidLibrary{}
472
473 module.AddProperties(
474 &module.Module.properties,
475 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800476 &module.Module.dexpreoptProperties,
Colin Crossa97c5d32018-03-28 14:58:31 -0700477 &module.Module.protoProperties,
478 &module.aaptProperties,
479 &module.androidLibraryProperties)
480
481 module.androidLibraryProperties.BuildAAR = true
482
Colin Cross48de9a42018-10-02 13:53:33 -0700483 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700484 return module
485}
486
Colin Crossfabb6082018-02-20 17:22:23 -0800487//
488// AAR (android library) prebuilts
489//
Colin Crossfabb6082018-02-20 17:22:23 -0800490
491type AARImportProperties struct {
Colin Cross27b922f2019-03-04 22:35:41 -0800492 Aars []string `android:"path"`
Colin Crossfabb6082018-02-20 17:22:23 -0800493
Colin Cross479884c2018-07-10 13:39:30 -0700494 Sdk_version *string
495 Min_sdk_version *string
Colin Crossa97c5d32018-03-28 14:58:31 -0700496
497 Static_libs []string
498 Libs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -0700499
500 // if set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700501 Jetifier *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800502}
503
504type AARImport struct {
505 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700506 android.DefaultableModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800507 prebuilt android.Prebuilt
508
509 properties AARImportProperties
510
Colin Cross66f78822018-05-02 12:58:28 -0700511 classpathFile android.WritablePath
512 proguardFlags android.WritablePath
513 exportPackage android.WritablePath
514 extraAaptPackagesFile android.WritablePath
Colin Cross10f7c4a2018-05-23 10:59:28 -0700515 manifest android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700516
517 exportedStaticPackages android.Paths
Colin Crossfabb6082018-02-20 17:22:23 -0800518}
519
Colin Cross83bb3162018-06-25 15:48:06 -0700520func (a *AARImport) sdkVersion() string {
Jeongik Cha6bd33c12019-06-25 16:26:18 +0900521 return proptools.StringDefault(a.properties.Sdk_version, defaultSdkVersion(a))
Colin Cross83bb3162018-06-25 15:48:06 -0700522}
523
524func (a *AARImport) minSdkVersion() string {
Colin Cross479884c2018-07-10 13:39:30 -0700525 if a.properties.Min_sdk_version != nil {
526 return *a.properties.Min_sdk_version
527 }
Colin Cross83bb3162018-06-25 15:48:06 -0700528 return a.sdkVersion()
529}
530
Dan Willemsen419290a2018-10-31 15:28:47 -0700531func (a *AARImport) targetSdkVersion() string {
532 return a.sdkVersion()
533}
534
Colin Crossa97c5d32018-03-28 14:58:31 -0700535var _ AndroidLibraryDependency = (*AARImport)(nil)
536
537func (a *AARImport) ExportPackage() android.Path {
538 return a.exportPackage
539}
540
Colin Cross89c31582018-04-30 15:55:11 -0700541func (a *AARImport) ExportedProguardFlagFiles() android.Paths {
542 return android.Paths{a.proguardFlags}
543}
544
Anton Hansson53c88442019-03-18 15:53:16 +0000545func (a *AARImport) ExportedRRODirs() []rroDir {
Colin Crossc1c37552019-01-31 11:42:41 -0800546 return nil
547}
548
Colin Cross66f78822018-05-02 12:58:28 -0700549func (a *AARImport) ExportedStaticPackages() android.Paths {
550 return a.exportedStaticPackages
551}
552
Colin Cross90c25c62019-04-19 16:22:57 -0700553func (a *AARImport) ExportedManifests() android.Paths {
554 return android.Paths{a.manifest}
Colin Cross31656952018-05-24 16:11:20 -0700555}
556
Colin Crossfabb6082018-02-20 17:22:23 -0800557func (a *AARImport) Prebuilt() *android.Prebuilt {
558 return &a.prebuilt
559}
560
561func (a *AARImport) Name() string {
562 return a.prebuilt.Name(a.ModuleBase.Name())
563}
564
565func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross10932872019-04-18 14:27:12 -0700566 if !ctx.Config().UnbundledBuildUsePrebuiltSdks() {
Colin Cross83bb3162018-06-25 15:48:06 -0700567 sdkDep := decodeSdkDep(ctx, sdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -0700568 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -0700569 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -0800570 }
571 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700572
Colin Cross42d48b72018-08-29 14:10:52 -0700573 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
574 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -0800575}
576
577// 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 -0700578// 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 -0800579var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
580 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -0700581 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
582 `unzip -qo -d $outDir $in && rm -rf $outDir/res && touch $out`,
Colin Crossfabb6082018-02-20 17:22:23 -0800583 },
Dan Willemsen304cfec2019-05-28 14:49:06 -0700584 "outDir")
Colin Crossfabb6082018-02-20 17:22:23 -0800585
586func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
587 if len(a.properties.Aars) != 1 {
588 ctx.PropertyErrorf("aars", "exactly one aar is required")
589 return
590 }
591
Nan Zhang4c819fb2018-08-27 18:31:46 -0700592 aarName := ctx.ModuleName() + ".aar"
593 var aar android.Path
594 aar = android.PathForModuleSrc(ctx, a.properties.Aars[0])
Colin Cross1001a792019-03-21 22:21:39 -0700595 if Bool(a.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -0700596 inputFile := aar
597 aar = android.PathForModuleOut(ctx, "jetifier", aarName)
598 TransformJetifier(ctx, aar.(android.WritablePath), inputFile)
599 }
Colin Crossfabb6082018-02-20 17:22:23 -0800600
601 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Crossfabb6082018-02-20 17:22:23 -0800602 a.classpathFile = extractedAARDir.Join(ctx, "classes.jar")
603 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross10f7c4a2018-05-23 10:59:28 -0700604 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossfabb6082018-02-20 17:22:23 -0800605
606 ctx.Build(pctx, android.BuildParams{
607 Rule: unzipAAR,
608 Input: aar,
Colin Cross10f7c4a2018-05-23 10:59:28 -0700609 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest},
Colin Crossfabb6082018-02-20 17:22:23 -0800610 Description: "unzip AAR",
611 Args: map[string]string{
Dan Willemsen304cfec2019-05-28 14:49:06 -0700612 "outDir": extractedAARDir.String(),
Colin Crossfabb6082018-02-20 17:22:23 -0800613 },
614 })
615
Colin Crossa0ba2f52019-06-22 12:59:27 -0700616 // Always set --pseudo-localize, it will be stripped out later for release
617 // builds that don't want it.
618 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -0800619 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -0800620 flata := compiledResDir.Join(ctx, "gen_res.flata")
Colin Crossa0ba2f52019-06-22 12:59:27 -0700621 aapt2CompileZip(ctx, flata, aar, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -0800622
623 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900624 // the subdir "android" is required to be filtered by package names
625 srcJar := android.PathForModuleGen(ctx, "android", "R.srcjar")
Colin Crossfabb6082018-02-20 17:22:23 -0800626 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossa97c5d32018-03-28 14:58:31 -0700627 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700628 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -0800629
630 var linkDeps android.Paths
631
632 linkFlags := []string{
633 "--static-lib",
634 "--no-static-lib-packages",
635 "--auto-add-overlay",
636 }
637
Colin Cross10f7c4a2018-05-23 10:59:28 -0700638 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
639 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -0800640
Colin Cross5446e882019-05-22 10:46:27 -0700641 transitiveStaticLibs, staticLibManifests, staticRRODirs, libDeps, libFlags, sdkLibraries :=
642 aaptLibs(ctx, sdkContext(a))
Colin Cross31656952018-05-24 16:11:20 -0700643
644 _ = staticLibManifests
Colin Crossc1c37552019-01-31 11:42:41 -0800645 _ = staticRRODirs
Colin Cross5446e882019-05-22 10:46:27 -0700646 _ = sdkLibraries
Colin Crossfabb6082018-02-20 17:22:23 -0800647
Colin Crossa97c5d32018-03-28 14:58:31 -0700648 linkDeps = append(linkDeps, libDeps...)
649 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -0800650
Colin Cross66f78822018-05-02 12:58:28 -0700651 overlayRes := append(android.Paths{flata}, transitiveStaticLibs...)
Colin Crossfabb6082018-02-20 17:22:23 -0800652
Colin Cross66f78822018-05-02 12:58:28 -0700653 aapt2Link(ctx, a.exportPackage, srcJar, proguardOptionsFile, rTxt, a.extraAaptPackagesFile,
Colin Crosse560c4a2019-03-19 16:03:11 -0700654 linkFlags, linkDeps, nil, overlayRes, nil)
Colin Crossfabb6082018-02-20 17:22:23 -0800655}
656
657var _ Dependency = (*AARImport)(nil)
658
659func (a *AARImport) HeaderJars() android.Paths {
660 return android.Paths{a.classpathFile}
661}
662
663func (a *AARImport) ImplementationJars() android.Paths {
664 return android.Paths{a.classpathFile}
665}
666
Colin Cross331a1212018-08-15 20:40:52 -0700667func (a *AARImport) ResourceJars() android.Paths {
668 return nil
669}
670
671func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
672 return android.Paths{a.classpathFile}
673}
674
Colin Crossf24a22a2019-01-31 14:12:44 -0800675func (a *AARImport) DexJar() android.Path {
676 return nil
677}
678
Colin Crossfabb6082018-02-20 17:22:23 -0800679func (a *AARImport) AidlIncludeDirs() android.Paths {
680 return nil
681}
682
Jiyong Park1be96912018-05-28 18:02:19 +0900683func (a *AARImport) ExportedSdkLibs() []string {
684 return nil
685}
686
Colin Cross0c4ce212019-05-03 15:28:19 -0700687func (a *AARImport) SrcJarArgs() ([]string, android.Paths) {
688 return nil, nil
689}
690
Colin Crossfabb6082018-02-20 17:22:23 -0800691var _ android.PrebuiltInterface = (*Import)(nil)
692
Colin Cross1b16b0e2019-02-12 14:41:32 -0800693// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
694//
695// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
696// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -0800697func AARImportFactory() android.Module {
698 module := &AARImport{}
699
700 module.AddProperties(&module.properties)
701
702 android.InitPrebuiltModule(module, &module.properties.Aars)
Colin Cross48de9a42018-10-02 13:53:33 -0700703 InitJavaModule(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -0800704 return module
705}