// Copyright 2018 Google Inc. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package java import ( "fmt" "path/filepath" "strings" "android/soong/android" "github.com/google/blueprint" "github.com/google/blueprint/proptools" ) type AndroidLibraryDependency interface { Dependency ExportPackage() android.Path ExportedProguardFlagFiles() android.Paths ExportedRRODirs() []rroDir ExportedStaticPackages() android.Paths ExportedManifests() android.Paths } func init() { RegisterAARBuildComponents(android.InitRegistrationContext) } func RegisterAARBuildComponents(ctx android.RegistrationContext) { ctx.RegisterModuleType("android_library_import", AARImportFactory) ctx.RegisterModuleType("android_library", AndroidLibraryFactory) } // // AAR (android library) // type androidLibraryProperties struct { BuildAAR bool `blueprint:"mutated"` } type aaptProperties struct { // flags passed to aapt when creating the apk Aaptflags []string // include all resource configurations, not just the product-configured // ones. Aapt_include_all_resources *bool // list of directories relative to the Blueprints file containing assets. // Defaults to ["assets"] if a directory called assets exists. Set to [] // to disable the default. Asset_dirs []string // list of directories relative to the Blueprints file containing // Android resources. Defaults to ["res"] if a directory called res exists. // Set to [] to disable the default. Resource_dirs []string // list of zip files containing Android resources. Resource_zips []string `android:"path"` // path to AndroidManifest.xml. If unset, defaults to "AndroidManifest.xml". Manifest *string `android:"path"` // paths to additional manifest files to merge with main manifest. Additional_manifests []string `android:"path"` // do not include AndroidManifest from dependent libraries Dont_merge_manifests *bool } type aapt struct { aaptSrcJar android.Path exportPackage android.Path manifestPath android.Path transitiveManifestPaths android.Paths proguardOptionsFile android.Path rroDirs []rroDir rTxt android.Path extraAaptPackagesFile android.Path mergedManifestFile android.Path noticeFile android.OptionalPath isLibrary bool useEmbeddedNativeLibs bool useEmbeddedDex bool usesNonSdkApis bool sdkLibraries []string hasNoCode bool splitNames []string splits []split aaptProperties aaptProperties } type split struct { name string suffix string path android.Path } func (a *aapt) ExportPackage() android.Path { return a.exportPackage } func (a *aapt) ExportedRRODirs() []rroDir { return a.rroDirs } func (a *aapt) ExportedManifests() android.Paths { return a.transitiveManifestPaths } func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext sdkContext, manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths, resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) { hasVersionCode := false hasVersionName := false for _, f := range a.aaptProperties.Aaptflags { if strings.HasPrefix(f, "--version-code") { hasVersionCode = true } else if strings.HasPrefix(f, "--version-name") { hasVersionName = true } } // Flags specified in Android.bp linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...) linkFlags = append(linkFlags, "--no-static-lib-packages") // Find implicit or explicit asset and resource dirs assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets") resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res") resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips) // Glob directories into lists of paths for _, dir := range resourceDirs { resDirs = append(resDirs, globbedResourceDir{ dir: dir, files: androidResourceGlob(ctx, dir), }) resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, dir) overlayDirs = append(overlayDirs, resOverlayDirs...) rroDirs = append(rroDirs, resRRODirs...) } var assetFiles android.Paths for _, dir := range assetDirs { assetFiles = append(assetFiles, androidResourceGlob(ctx, dir)...) } assetDirStrings := assetDirs.Strings() if a.noticeFile.Valid() { assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String())) assetFiles = append(assetFiles, a.noticeFile.Path()) } linkFlags = append(linkFlags, "--manifest "+manifestPath.String()) linkDeps = append(linkDeps, manifestPath) linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A ")) linkDeps = append(linkDeps, assetFiles...) // SDK version flags minSdkVersion := sdkVersionOrDefault(ctx, sdkContext.minSdkVersion()) linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion) linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion) // Version code if !hasVersionCode { linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion()) } if !hasVersionName { var versionName string if ctx.ModuleName() == "framework-res" { // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things // if it contains the build number. Use the PlatformVersionName instead. versionName = ctx.Config().PlatformVersionName() } else { versionName = ctx.Config().AppsDefaultVersionName() } versionName = proptools.NinjaEscape(versionName) linkFlags = append(linkFlags, "--version-name ", versionName) } linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"}) // Always set --pseudo-localize, it will be stripped out later for release // builds that don't want it. compileFlags = append(compileFlags, "--pseudo-localize") return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips } func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) { if sdkDep.frameworkResModule != "" { ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule) } } func (a *aapt) buildActions(ctx android.ModuleContext, sdkContext sdkContext, extraLinkFlags ...string) { transitiveStaticLibs, transitiveStaticLibManifests, staticRRODirs, libDeps, libFlags, sdkLibraries := aaptLibs(ctx, sdkContext) // App manifest file manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml") manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile) manifestPath := manifestFixer(ctx, manifestSrcPath, sdkContext, sdkLibraries, a.isLibrary, a.useEmbeddedNativeLibs, a.usesNonSdkApis, a.useEmbeddedDex, a.hasNoCode) // Add additional manifest files to transitive manifests. additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests) a.transitiveManifestPaths = append(android.Paths{manifestPath}, additionalManifests...) a.transitiveManifestPaths = append(a.transitiveManifestPaths, transitiveStaticLibManifests...) if len(a.transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) { a.mergedManifestFile = manifestMerger(ctx, a.transitiveManifestPaths[0], a.transitiveManifestPaths[1:], a.isLibrary) if !a.isLibrary { // Only use the merged manifest for applications. For libraries, the transitive closure of manifests // will be propagated to the final application and merged there. The merged manifest for libraries is // only passed to Make, which can't handle transitive dependencies. manifestPath = a.mergedManifestFile } } else { a.mergedManifestFile = manifestPath } compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, sdkContext, manifestPath) rroDirs = append(rroDirs, staticRRODirs...) linkFlags = append(linkFlags, libFlags...) linkDeps = append(linkDeps, libDeps...) linkFlags = append(linkFlags, extraLinkFlags...) if a.isLibrary { linkFlags = append(linkFlags, "--static-lib") } packageRes := android.PathForModuleOut(ctx, "package-res.apk") // the subdir "android" is required to be filtered by package names srcJar := android.PathForModuleGen(ctx, "android", "R.srcjar") proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options") rTxt := android.PathForModuleOut(ctx, "R.txt") // This file isn't used by Soong, but is generated for exporting extraPackages := android.PathForModuleOut(ctx, "extra_packages") var compiledResDirs []android.Paths for _, dir := range resDirs { compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths()) } for i, zip := range resZips { flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i)) aapt2CompileZip(ctx, flata, zip, "", compileFlags) compiledResDirs = append(compiledResDirs, android.Paths{flata}) } var compiledRes, compiledOverlay android.Paths compiledOverlay = append(compiledOverlay, transitiveStaticLibs...) if len(transitiveStaticLibs) > 0 { // If we are using static android libraries, every source file becomes an overlay. // This is to emulate old AAPT behavior which simulated library support. for _, compiledResDir := range compiledResDirs { compiledOverlay = append(compiledOverlay, compiledResDir...) } } else if a.isLibrary { // Otherwise, for a static library we treat all the resources equally with no overlay. for _, compiledResDir := range compiledResDirs { compiledRes = append(compiledRes, compiledResDir...) } } else if len(compiledResDirs) > 0 { // Without static libraries, the first directory is our directory, which can then be // overlaid by the rest. compiledRes = append(compiledRes, compiledResDirs[0]...) for _, compiledResDir := range compiledResDirs[1:] { compiledOverlay = append(compiledOverlay, compiledResDir...) } } for _, dir := range overlayDirs { compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths()...) } var splitPackages android.WritablePaths var splits []split for _, s := range a.splitNames { suffix := strings.Replace(s, ",", "_", -1) path := android.PathForModuleOut(ctx, "package_"+suffix+".apk") linkFlags = append(linkFlags, "--split", path.String()+":"+s) splitPackages = append(splitPackages, path) splits = append(splits, split{ name: s, suffix: suffix, path: path, }) } aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt, extraPackages, linkFlags, linkDeps, compiledRes, compiledOverlay, splitPackages) a.aaptSrcJar = srcJar a.exportPackage = packageRes a.manifestPath = manifestPath a.proguardOptionsFile = proguardOptionsFile a.rroDirs = rroDirs a.extraAaptPackagesFile = extraPackages a.rTxt = rTxt a.splits = splits } // aaptLibs collects libraries from dependencies and sdk_version and converts them into paths func aaptLibs(ctx android.ModuleContext, sdkContext sdkContext) (transitiveStaticLibs, transitiveStaticLibManifests android.Paths, staticRRODirs []rroDir, deps android.Paths, flags []string, sdkLibraries []string) { var sharedLibs android.Paths sdkDep := decodeSdkDep(ctx, sdkContext) if sdkDep.useFiles { sharedLibs = append(sharedLibs, sdkDep.jars...) } ctx.VisitDirectDeps(func(module android.Module) { var exportPackage android.Path aarDep, _ := module.(AndroidLibraryDependency) if aarDep != nil { exportPackage = aarDep.ExportPackage() } switch ctx.OtherModuleDependencyTag(module) { case instrumentationForTag: // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2. case libTag: if exportPackage != nil { sharedLibs = append(sharedLibs, exportPackage) } if _, ok := module.(SdkLibraryDependency); ok { sdkLibraries = append(sdkLibraries, ctx.OtherModuleName(module)) } case frameworkResTag: if exportPackage != nil { sharedLibs = append(sharedLibs, exportPackage) } case staticLibTag: if exportPackage != nil { transitiveStaticLibs = append(transitiveStaticLibs, aarDep.ExportedStaticPackages()...) transitiveStaticLibs = append(transitiveStaticLibs, exportPackage) transitiveStaticLibManifests = append(transitiveStaticLibManifests, aarDep.ExportedManifests()...) sdkLibraries = append(sdkLibraries, aarDep.ExportedSdkLibs()...) outer: for _, d := range aarDep.ExportedRRODirs() { for _, e := range staticRRODirs { if d.path == e.path { continue outer } } staticRRODirs = append(staticRRODirs, d) } } } }) deps = append(deps, sharedLibs...) deps = append(deps, transitiveStaticLibs...) if len(transitiveStaticLibs) > 0 { flags = append(flags, "--auto-add-overlay") } for _, sharedLib := range sharedLibs { flags = append(flags, "-I "+sharedLib.String()) } transitiveStaticLibs = android.FirstUniquePaths(transitiveStaticLibs) transitiveStaticLibManifests = android.FirstUniquePaths(transitiveStaticLibManifests) sdkLibraries = android.FirstUniqueStrings(sdkLibraries) return transitiveStaticLibs, transitiveStaticLibManifests, staticRRODirs, deps, flags, sdkLibraries } type AndroidLibrary struct { Library aapt androidLibraryProperties androidLibraryProperties aarFile android.WritablePath exportedProguardFlagFiles android.Paths exportedStaticPackages android.Paths } func (a *AndroidLibrary) ExportedProguardFlagFiles() android.Paths { return a.exportedProguardFlagFiles } func (a *AndroidLibrary) ExportedStaticPackages() android.Paths { return a.exportedStaticPackages } var _ AndroidLibraryDependency = (*AndroidLibrary)(nil) func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) { a.Module.deps(ctx) sdkDep := decodeSdkDep(ctx, sdkContext(a)) if sdkDep.hasFrameworkLibs() { a.aapt.deps(ctx, sdkDep) } } func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) { a.aapt.isLibrary = true a.aapt.sdkLibraries = a.exportedSdkLibs a.aapt.buildActions(ctx, sdkContext(a)) ctx.CheckbuildFile(a.proguardOptionsFile) ctx.CheckbuildFile(a.exportPackage) ctx.CheckbuildFile(a.aaptSrcJar) // apps manifests are handled by aapt, don't let Module see them a.properties.Manifest = nil a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile) a.Module.compile(ctx, a.aaptSrcJar) a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar") var res android.Paths if a.androidLibraryProperties.BuildAAR { BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res) ctx.CheckbuildFile(a.aarFile) } ctx.VisitDirectDeps(func(m android.Module) { if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag { a.exportedProguardFlagFiles = append(a.exportedProguardFlagFiles, lib.ExportedProguardFlagFiles()...) a.exportedStaticPackages = append(a.exportedStaticPackages, lib.ExportPackage()) a.exportedStaticPackages = append(a.exportedStaticPackages, lib.ExportedStaticPackages()...) } }) a.exportedProguardFlagFiles = android.FirstUniquePaths(a.exportedProguardFlagFiles) a.exportedStaticPackages = android.FirstUniquePaths(a.exportedStaticPackages) } // android_library builds and links sources into a `.jar` file for the device along with Android resources. // // An android_library has a single variant that produces a `.jar` file containing `.class` files that were // compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled // with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of // an android_app module. func AndroidLibraryFactory() android.Module { module := &AndroidLibrary{} module.AddProperties( &module.Module.properties, &module.Module.deviceProperties, &module.Module.dexpreoptProperties, &module.Module.protoProperties, &module.aaptProperties, &module.androidLibraryProperties) module.androidLibraryProperties.BuildAAR = true InitJavaModule(module, android.DeviceSupported) return module } // // AAR (android library) prebuilts // type AARImportProperties struct { Aars []string `android:"path"` Sdk_version *string Min_sdk_version *string Static_libs []string Libs []string // if set to true, run Jetifier against .aar file. Defaults to false. Jetifier *bool } type AARImport struct { android.ModuleBase android.DefaultableModuleBase prebuilt android.Prebuilt properties AARImportProperties classpathFile android.WritablePath proguardFlags android.WritablePath exportPackage android.WritablePath extraAaptPackagesFile android.WritablePath manifest android.WritablePath exportedStaticPackages android.Paths } func (a *AARImport) sdkVersion() string { return String(a.properties.Sdk_version) } func (a *AARImport) systemModules() string { return "" } func (a *AARImport) minSdkVersion() string { if a.properties.Min_sdk_version != nil { return *a.properties.Min_sdk_version } return a.sdkVersion() } func (a *AARImport) targetSdkVersion() string { return a.sdkVersion() } func (a *AARImport) javaVersion() string { return "" } var _ AndroidLibraryDependency = (*AARImport)(nil) func (a *AARImport) ExportPackage() android.Path { return a.exportPackage } func (a *AARImport) ExportedProguardFlagFiles() android.Paths { return android.Paths{a.proguardFlags} } func (a *AARImport) ExportedRRODirs() []rroDir { return nil } func (a *AARImport) ExportedStaticPackages() android.Paths { return a.exportedStaticPackages } func (a *AARImport) ExportedManifests() android.Paths { return android.Paths{a.manifest} } func (a *AARImport) Prebuilt() *android.Prebuilt { return &a.prebuilt } func (a *AARImport) Name() string { return a.prebuilt.Name(a.ModuleBase.Name()) } func (a *AARImport) JacocoReportClassesFile() android.Path { return nil } func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) { if !ctx.Config().UnbundledBuildUsePrebuiltSdks() { sdkDep := decodeSdkDep(ctx, sdkContext(a)) if sdkDep.useModule && sdkDep.frameworkResModule != "" { ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule) } } ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...) ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...) } // Unzip an AAR into its constituent files and directories. Any files in Outputs that don't exist in the AAR will be // touched to create an empty file. The res directory is not extracted, as it will be extracted in its own rule. var unzipAAR = pctx.AndroidStaticRule("unzipAAR", blueprint.RuleParams{ Command: `rm -rf $outDir && mkdir -p $outDir && ` + `unzip -qo -d $outDir $in && rm -rf $outDir/res && touch $out`, }, "outDir") func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) { if len(a.properties.Aars) != 1 { ctx.PropertyErrorf("aars", "exactly one aar is required") return } aarName := ctx.ModuleName() + ".aar" var aar android.Path aar = android.PathForModuleSrc(ctx, a.properties.Aars[0]) if Bool(a.properties.Jetifier) { inputFile := aar aar = android.PathForModuleOut(ctx, "jetifier", aarName) TransformJetifier(ctx, aar.(android.WritablePath), inputFile) } extractedAARDir := android.PathForModuleOut(ctx, "aar") a.classpathFile = extractedAARDir.Join(ctx, "classes.jar") a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt") a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml") ctx.Build(pctx, android.BuildParams{ Rule: unzipAAR, Input: aar, Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest}, Description: "unzip AAR", Args: map[string]string{ "outDir": extractedAARDir.String(), }, }) // Always set --pseudo-localize, it will be stripped out later for release // builds that don't want it. compileFlags := []string{"--pseudo-localize"} compiledResDir := android.PathForModuleOut(ctx, "flat-res") flata := compiledResDir.Join(ctx, "gen_res.flata") aapt2CompileZip(ctx, flata, aar, "res", compileFlags) a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk") // the subdir "android" is required to be filtered by package names srcJar := android.PathForModuleGen(ctx, "android", "R.srcjar") proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options") rTxt := android.PathForModuleOut(ctx, "R.txt") a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages") var linkDeps android.Paths linkFlags := []string{ "--static-lib", "--no-static-lib-packages", "--auto-add-overlay", } linkFlags = append(linkFlags, "--manifest "+a.manifest.String()) linkDeps = append(linkDeps, a.manifest) transitiveStaticLibs, staticLibManifests, staticRRODirs, libDeps, libFlags, sdkLibraries := aaptLibs(ctx, sdkContext(a)) _ = staticLibManifests _ = staticRRODirs _ = sdkLibraries linkDeps = append(linkDeps, libDeps...) linkFlags = append(linkFlags, libFlags...) overlayRes := append(android.Paths{flata}, transitiveStaticLibs...) aapt2Link(ctx, a.exportPackage, srcJar, proguardOptionsFile, rTxt, a.extraAaptPackagesFile, linkFlags, linkDeps, nil, overlayRes, nil) } var _ Dependency = (*AARImport)(nil) func (a *AARImport) HeaderJars() android.Paths { return android.Paths{a.classpathFile} } func (a *AARImport) ImplementationJars() android.Paths { return android.Paths{a.classpathFile} } func (a *AARImport) ResourceJars() android.Paths { return nil } func (a *AARImport) ImplementationAndResourcesJars() android.Paths { return android.Paths{a.classpathFile} } func (a *AARImport) DexJar() android.Path { return nil } func (a *AARImport) AidlIncludeDirs() android.Paths { return nil } func (a *AARImport) ExportedSdkLibs() []string { return nil } func (d *AARImport) ExportedPlugins() (android.Paths, []string) { return nil, nil } func (a *AARImport) SrcJarArgs() ([]string, android.Paths) { return nil, nil } var _ android.PrebuiltInterface = (*Import)(nil) // android_library_import imports an `.aar` file into the build graph as if it was built with android_library. // // This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of // an android_app module. func AARImportFactory() android.Module { module := &AARImport{} module.AddProperties(&module.properties) android.InitPrebuiltModule(module, &module.properties.Aars) InitJavaModule(module, android.DeviceSupported) return module }