StrixOS/build_soong
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Replace PropertyCustomizer with hooks"

Browse Source
This commit is contained in:
Colin Cross
2016-09-14 16:50:18 +00:00
committed by Gerrit Code Review
parent dded092368 178a509855
commit d784cff36a
4 changed files with 182 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Android.bp
View File

@@ -63,10 +63,10 @@ bootstrap_go_package {
"android/androidmk.go",
"android/arch.go",
"android/config.go",
"android/customizer.go",
"android/defaults.go",
"android/defs.go",
"android/glob.go",
"android/hooks.go",
"android/makevars.go",
"android/module.go",
"android/mutator.go",

77
android/customizer.go
View File

@@ -1,77 +0,0 @@
// Copyright 2016 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 android
import "github.com/google/blueprint/proptools"
type CustomizePropertiesContext interface {
BaseContext
AppendProperties(...interface{})
PrependProperties(...interface{})
}
type customizePropertiesContext struct {
BaseContext
module *ModuleBase
}
type PropertyCustomizer interface {
CustomizeProperties(CustomizePropertiesContext)
}
func customizerMutator(ctx TopDownMutatorContext) {
if m, ok := ctx.Module().(Module); ok {
a := m.base()
if len(a.customizers) > 0 {
mctx := &customizePropertiesContext{
BaseContext: ctx,
module: a,
}
for _, c := range a.customizers {
c.CustomizeProperties(mctx)
if mctx.Failed() {
return
}
}
}
}
}
func (ctx *customizePropertiesContext) AppendProperties(props ...interface{}) {
for _, p := range props {
err := proptools.AppendMatchingProperties(ctx.module.customizableProperties, p, nil)
if err != nil {
if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
} else {
panic(err)
}
}
}
}
func (ctx *customizePropertiesContext) PrependProperties(props ...interface{}) {
for _, p := range props {
err := proptools.PrependMatchingProperties(ctx.module.customizableProperties, p, nil)
if err != nil {
if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
} else {
panic(err)
}
}
}
}

176
android/hooks.go Normal file
View File

@@ -0,0 +1,176 @@
// Copyright 2016 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 android
import (
"github.com/google/blueprint"
"github.com/google/blueprint/proptools"
)
// This file implements hooks that external module types can use to inject logic into existing
// module types. Each hook takes an interface as a parameter so that new methods can be added
// to the interface without breaking existing module types.
// Load hooks are run after the module's properties have been filled from the blueprint file, but
// before the module has been split into architecture variants, and before defaults modules have
// been applied.
type LoadHookContext interface {
// TODO: a new context that includes AConfig() but not Target(), etc.?
BaseContext
AppendProperties(...interface{})
PrependProperties(...interface{})
}
// Arch hooks are run after the module has been split into architecture variants, and can be used
// to add architecture-specific properties.
type ArchHookContext interface {
BaseContext
AppendProperties(...interface{})
PrependProperties(...interface{})
}
func AddLoadHook(m blueprint.Module, hook func(LoadHookContext)) {
h := &m.(Module).base().hooks
h.load = append(h.load, hook)
}
func AddArchHook(m blueprint.Module, hook func(ArchHookContext)) {
h := &m.(Module).base().hooks
h.arch = append(h.arch, hook)
}
type propertyHookContext struct {
BaseContext
module *ModuleBase
}
func (ctx *propertyHookContext) AppendProperties(props ...interface{}) {
for _, p := range props {
err := proptools.AppendMatchingProperties(ctx.module.customizableProperties, p, nil)
if err != nil {
if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
} else {
panic(err)
}
}
}
}
func (ctx *propertyHookContext) PrependProperties(props ...interface{}) {
for _, p := range props {
err := proptools.PrependMatchingProperties(ctx.module.customizableProperties, p, nil)
if err != nil {
if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
} else {
panic(err)
}
}
}
}
func (x *hooks) runLoadHooks(ctx BaseContext, m *ModuleBase) {
if len(x.load) > 0 {
mctx := &propertyHookContext{
BaseContext: ctx,
module: m,
}
for _, x := range x.load {
x(mctx)
if mctx.Failed() {
return
}
}
}
}
func (x *hooks) runArchHooks(ctx BaseContext, m *ModuleBase) {
if len(x.arch) > 0 {
mctx := &propertyHookContext{
BaseContext: ctx,
module: m,
}
for _, x := range x.arch {
x(mctx)
if mctx.Failed() {
return
}
}
}
}
type InstallHookContext interface {
ModuleContext
Path() OutputPath
Symlink() bool
}
// Install hooks are run after a module creates a rule to install a file or symlink.
// The installed path is available from InstallHookContext.Path(), and
// InstallHookContext.Symlink() will be true if it was a symlink.
func AddInstallHook(m blueprint.Module, hook func(InstallHookContext)) {
h := &m.(Module).base().hooks
h.install = append(h.install, hook)
}
type installHookContext struct {
ModuleContext
path OutputPath
symlink bool
}
func (x *installHookContext) Path() OutputPath {
return x.path
}
func (x *installHookContext) Symlink() bool {
return x.symlink
}
func (x *hooks) runInstallHooks(ctx ModuleContext, path OutputPath, symlink bool) {
if len(x.install) > 0 {
mctx := &installHookContext{
ModuleContext: ctx,
path: path,
symlink: symlink,
}
for _, x := range x.install {
x(mctx)
if mctx.Failed() {
return
}
}
}
}
type hooks struct {
load []func(LoadHookContext)
arch []func(ArchHookContext)
install []func(InstallHookContext)
}
func loadHookMutator(ctx TopDownMutatorContext) {
if m, ok := ctx.Module().(Module); ok {
m.base().hooks.runLoadHooks(ctx, m.base())
}
}
func archHookMutator(ctx TopDownMutatorContext) {
if m, ok := ctx.Module().(Module); ok {
m.base().hooks.runArchHooks(ctx, m.base())
}
}

12
android/module.go
View File

@@ -26,11 +26,12 @@ import (
)
func init() {
RegisterTopDownMutator("customizer", customizerMutator).Parallel()
RegisterTopDownMutator("load_hooks", loadHookMutator).Parallel()
RegisterBottomUpMutator("defaults_deps", defaultsDepsMutator).Parallel()
RegisterTopDownMutator("defaults", defaultsMutator).Parallel()
RegisterBottomUpMutator("arch", ArchMutator).Parallel()
RegisterTopDownMutator("arch_hooks", archHookMutator).Parallel()
}
var (
@@ -210,11 +211,6 @@ func InitAndroidArchModule(m Module, hod HostOrDeviceSupported, defaultMultilib
return InitArchModule(m, propertyStructs...)
}
func AddCustomizer(m blueprint.Module, c PropertyCustomizer) {
base := m.(Module).base()
base.customizers = append(base.customizers, c)
}
// A AndroidModuleBase object contains the properties that are common to all Android
// modules. It should be included as an anonymous field in every module
// struct definition. InitAndroidModule should then be called from the module's
@@ -277,7 +273,7 @@ type ModuleBase struct {
checkbuildTarget string
blueprintDir string
customizers []PropertyCustomizer
hooks hooks
}
func (a *ModuleBase) base() *ModuleBase {
@@ -597,6 +593,7 @@ func (a *androidModuleContext) InstallFileName(installPath OutputPath, name stri
deps ...Path) OutputPath {
fullInstallPath := installPath.Join(a, name)
a.module.base().hooks.runInstallHooks(a, fullInstallPath, false)
if a.Host() || !a.AConfig().SkipDeviceInstall() {
deps = append(deps, a.installDeps...)
@@ -621,6 +618,7 @@ func (a *androidModuleContext) InstallFile(installPath OutputPath, srcPath Path,
func (a *androidModuleContext) InstallSymlink(installPath OutputPath, name string, srcPath OutputPath) OutputPath {
fullInstallPath := installPath.Join(a, name)
a.module.base().hooks.runInstallHooks(a, fullInstallPath, true)
if a.Host() || !a.AConfig().SkipDeviceInstall() {
a.ModuleBuild(pctx, ModuleBuildParams{