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}
39
40type packageModule struct {
41	ModuleBase
42
43	properties packageProperties
44}
45
46func (p *packageModule) GenerateAndroidBuildActions(ModuleContext) {
47	// Nothing to do.
48}
49
50func (p *packageModule) GenerateBuildActions(ctx blueprint.ModuleContext) {
51	// Nothing to do.
52}
53
54func (p *packageModule) qualifiedModuleId(ctx BaseModuleContext) qualifiedModuleName {
55	// Override to create a package id.
56	return newPackageId(ctx.ModuleDir())
57}
58
59func PackageFactory() Module {
60	module := &packageModule{}
61
62	module.AddProperties(&module.properties)
63
64	// The name is the relative path from build root to the directory containing this
65	// module. Set that name at the earliest possible moment that information is available
66	// which is in a LoadHook.
67	AddLoadHook(module, func(ctx LoadHookContext) {
68		module.nameProperties.Name = proptools.StringPtr("//" + ctx.ModuleDir())
69	})
70
71	// The default_visibility property needs to be checked and parsed by the visibility module during
72	// its checking and parsing phases so make it the primary visibility property.
73	setPrimaryVisibilityProperty(module, "default_visibility", &module.properties.Default_visibility)
74
75	// The default_applicable_licenses property needs to be checked and parsed by the licenses module during
76	// its checking and parsing phases so make it the primary licenses property.
77	setPrimaryLicensesProperty(module, "default_applicable_licenses", &module.properties.Default_applicable_licenses)
78
79	return module
80}
81