1// Copyright 2019 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 android 16 17import ( 18 "github.com/google/blueprint" 19 "github.com/google/blueprint/proptools" 20) 21 22func init() { 23 RegisterPackageBuildComponents(InitRegistrationContext) 24} 25 26var PrepareForTestWithPackageModule = FixtureRegisterWithContext(RegisterPackageBuildComponents) 27 28// Register the package module type. 29func RegisterPackageBuildComponents(ctx RegistrationContext) { 30 ctx.RegisterModuleType("package", PackageFactory) 31} 32 33type packageProperties struct { 34 // Specifies the default visibility for all modules defined in this package. 35 Default_visibility []string 36 // Specifies the default license terms for all modules defined in this package. 37 Default_applicable_licenses []string 38 Default_team *string `android:"path"` 39} 40 41type PackageInfo struct { 42 Properties packageProperties 43} 44 45var PackageInfoProvider = blueprint.NewProvider[PackageInfo]() 46 47type packageModule struct { 48 ModuleBase 49 50 properties packageProperties 51} 52 53func (p *packageModule) GenerateAndroidBuildActions(ModuleContext) { 54 // Nothing to do. 55} 56 57func (p *packageModule) DepsMutator(ctx BottomUpMutatorContext) { 58 // Add the dependency to do a validity check 59 if p.properties.Default_team != nil { 60 ctx.AddDependency(ctx.Module(), nil, *p.properties.Default_team) 61 } 62} 63 64func (p *packageModule) GenerateBuildActions(ctx blueprint.ModuleContext) { 65 ctx.SetProvider(CommonModuleInfoProvider, &CommonModuleInfo{ 66 Enabled: true, 67 PrimaryLicensesProperty: p.primaryLicensesProperty, 68 }) 69 70 ctx.SetProvider(PackageInfoProvider, PackageInfo{ 71 Properties: p.properties, 72 }) 73} 74 75func (p *packageModule) qualifiedModuleId(ctx BaseModuleContext) qualifiedModuleName { 76 // Override to create a package id. 77 return newPackageId(ctx.ModuleDir()) 78} 79 80func PackageFactory() Module { 81 module := &packageModule{} 82 83 module.AddProperties(&module.properties) 84 85 // The name is the relative path from build root to the directory containing this 86 // module. Set that name at the earliest possible moment that information is available 87 // which is in a LoadHook. 88 AddLoadHook(module, func(ctx LoadHookContext) { 89 module.nameProperties.Name = proptools.StringPtr("//" + ctx.ModuleDir()) 90 }) 91 92 // The default_visibility property needs to be checked and parsed by the visibility module during 93 // its checking and parsing phases so make it the primary visibility property. 94 setPrimaryVisibilityProperty(module, "default_visibility", &module.properties.Default_visibility) 95 96 // The default_applicable_licenses property needs to be checked and parsed by the licenses module during 97 // its checking and parsing phases so make it the primary licenses property. 98 setPrimaryLicensesProperty(module, "default_applicable_licenses", &module.properties.Default_applicable_licenses) 99 100 return module 101} 102