aboutsummaryrefslogtreecommitdiff
path: root/android/paths.go
diff options
context:
space:
mode:
Diffstat (limited to 'android/paths.go')
-rw-r--r--android/paths.go179
1 files changed, 46 insertions, 133 deletions
diff --git a/android/paths.go b/android/paths.go
index 7baf71f5b..3f768e5fc 100644
--- a/android/paths.go
+++ b/android/paths.go
@@ -24,10 +24,11 @@ import (
"strings"
"github.com/google/blueprint"
- "github.com/google/blueprint/gobtools"
"github.com/google/blueprint/pathtools"
)
+//go:generate go run ../../blueprint/gobtools/codegen/gob_gen.go
+
var absSrcDir string
// PathContext is the subset of a (Module|Singleton)Context required by the
@@ -60,7 +61,7 @@ type EarlyModulePathContext interface {
ModuleDir() string
ModuleErrorf(fmt string, args ...interface{})
- OtherModulePropertyErrorf(module Module, property, fmt string, args ...interface{})
+ OtherModulePropertyErrorf(module ModuleOrProxy, property, fmt string, args ...interface{})
}
var _ EarlyModulePathContext = ModuleContext(nil)
@@ -93,7 +94,7 @@ type ModuleWithDepsPathContext interface {
VisitDirectDeps(visit func(Module))
VisitDirectDepsProxy(visit func(ModuleProxy))
VisitDirectDepsProxyWithTag(tag blueprint.DependencyTag, visit func(ModuleProxy))
- OtherModuleDependencyTag(m blueprint.Module) blueprint.DependencyTag
+ OtherModuleDependencyTag(m ModuleOrProxy) blueprint.DependencyTag
HasMutatorFinished(mutatorName string) bool
}
@@ -235,12 +236,14 @@ func ReportPathErrorf(ctx PathContext, format string, args ...interface{}) {
}
}
-// TODO(b/397766191): Change the signature to take ModuleProxy
-// Please only access the module's internal data through providers.
-func pathContextName(ctx PathContext, module blueprint.Module) string {
- if x, ok := ctx.(interface{ ModuleName(blueprint.Module) string }); ok {
+func pathContextName(ctx PathContext, module ModuleOrProxy) string {
+ if x, ok := ctx.(interface {
+ ModuleName(ModuleOrProxy) string
+ }); ok {
return x.ModuleName(module)
- } else if x, ok := ctx.(interface{ OtherModuleName(blueprint.Module) string }); ok {
+ } else if x, ok := ctx.(interface {
+ OtherModuleName(ModuleOrProxy) string
+ }); ok {
return x.OtherModuleName(module)
}
return "unknown"
@@ -360,16 +363,12 @@ func ResPathWithName(ctx ModuleOutPathContext, p Path, name string) ModuleResPat
}
// OptionalPath is a container that may or may not contain a valid Path.
+// @auto-generate: gob
type OptionalPath struct {
path Path // nil if invalid.
invalidReason string // Not applicable if path != nil. "" if the reason is unknown.
}
-type optionalPathGob struct {
- Path Path
- InvalidReason string
-}
-
// OptionalPathForPath returns an OptionalPath containing the path.
func OptionalPathForPath(path Path) OptionalPath {
return OptionalPath{path: path}
@@ -381,26 +380,6 @@ func InvalidOptionalPath(reason string) OptionalPath {
return OptionalPath{invalidReason: reason}
}
-func (p *OptionalPath) ToGob() *optionalPathGob {
- return &optionalPathGob{
- Path: p.path,
- InvalidReason: p.invalidReason,
- }
-}
-
-func (p *OptionalPath) FromGob(data *optionalPathGob) {
- p.path = data.Path
- p.invalidReason = data.InvalidReason
-}
-
-func (p OptionalPath) GobEncode() ([]byte, error) {
- return gobtools.CustomGobEncode[optionalPathGob](&p)
-}
-
-func (p *OptionalPath) GobDecode(data []byte) error {
- return gobtools.CustomGobDecode[optionalPathGob](data, p)
-}
-
// Valid returns whether there is a valid path
func (p OptionalPath) Valid() bool {
return p.path != nil
@@ -461,6 +440,7 @@ func (p OptionalPath) String() string {
}
// Paths is a slice of Path objects, with helpers to operate on the collection.
+// @auto-generate: gob
type Paths []Path
// RelativeToTop creates a new Paths containing the result of calling Path.RelativeToTop on each
@@ -598,6 +578,14 @@ var _ DirectoryPath = (*directoryPath)(nil)
type DirectoryPaths []DirectoryPath
+func (paths DirectoryPaths) Strings() []string {
+ ret := make([]string, 0, len(paths))
+ for _, path := range paths {
+ ret = append(ret, path.String())
+ }
+ return ret
+}
+
// DirectoryPathsForModuleSrcExcludes returns a Paths{} containing the resolved references in
// directory paths. Elements of paths are resolved as:
// - filepath, relative to local module directory, resolves as a filepath relative to the local
@@ -609,7 +597,7 @@ func DirectoryPathsForModuleSrc(ctx ModuleMissingDepsPathContext, paths []string
for _, path := range paths {
if m, t := SrcIsModuleWithTag(path); m != "" {
module := GetModuleProxyFromPathDep(ctx, m, t)
- if module == nil {
+ if module.IsNil() {
ctx.ModuleErrorf(`missing dependency on %q, is the property annotated with android:"path"?`, m)
continue
}
@@ -621,7 +609,7 @@ func DirectoryPathsForModuleSrc(ctx ModuleMissingDepsPathContext, paths []string
if !ok {
panic(fmt.Errorf("%s is not an OtherModuleProviderContext", ctx))
}
- if dirProvider, ok := OtherModuleProvider(mctx, *module, DirProvider); ok {
+ if dirProvider, ok := OtherModuleProvider(mctx, module, DirProvider); ok {
ret = append(ret, dirProvider.Dirs...)
} else {
ReportPathErrorf(ctx, "module %q does not implement DirProvider", module)
@@ -680,14 +668,14 @@ func (p OutputPaths) Strings() []string {
// If the module dependency is not a SourceFileProducer or OutputFileProducer, appropriate errors will be returned.
func getPathsFromModuleDep(ctx ModuleWithDepsPathContext, path, moduleName, tag string) (Paths, error) {
module := GetModuleProxyFromPathDep(ctx, moduleName, tag)
- if module == nil {
+ if module.IsNil() {
return nil, missingDependencyError{[]string{moduleName}}
}
- if !OtherModulePointerProviderOrDefault(ctx, *module, CommonModuleInfoProvider).Enabled {
+ if !OtherModulePointerProviderOrDefault(ctx, module, CommonModuleInfoProvider).Enabled {
return nil, missingDependencyError{[]string{moduleName}}
}
- outputFiles, err := outputFilesForModule(ctx, *module, tag)
+ outputFiles, err := outputFilesForModule(ctx, module, tag)
if outputFiles != nil && err == nil {
return outputFiles, nil
} else {
@@ -705,8 +693,8 @@ func getPathsFromModuleDep(ctx ModuleWithDepsPathContext, path, moduleName, tag
//
// If tag is "" then the returned module will be the dependency that was added for ":moduleName".
// Otherwise, it is the dependency that was added for ":moduleName{tag}".
-func GetModuleProxyFromPathDep(ctx ModuleWithDepsPathContext, moduleName, tag string) *ModuleProxy {
- var found *ModuleProxy
+func GetModuleProxyFromPathDep(ctx ModuleWithDepsPathContext, moduleName, tag string) ModuleProxy {
+ var found ModuleProxy
// The sourceOrOutputDepTag uniquely identifies the module dependency as it contains both the
// module name and the tag. Dependencies added automatically for properties tagged with
// `android:"path"` are deduped so are guaranteed to be unique. It is possible for duplicate
@@ -720,7 +708,7 @@ func GetModuleProxyFromPathDep(ctx ModuleWithDepsPathContext, moduleName, tag st
// this finds the matching dependency module.
expectedTag := sourceOrOutputDepTag(moduleName, tag)
ctx.VisitDirectDepsProxyWithTag(expectedTag, func(module ModuleProxy) {
- found = &module
+ found = module
})
return found
}
@@ -1202,36 +1190,12 @@ func (p WritablePaths) Paths() Paths {
return ret
}
+// @auto-generate: gob
type basePath struct {
path string
rel string
}
-type basePathGob struct {
- Path string
- Rel string
-}
-
-func (p *basePath) ToGob() *basePathGob {
- return &basePathGob{
- Path: p.path,
- Rel: p.rel,
- }
-}
-
-func (p *basePath) FromGob(data *basePathGob) {
- p.path = data.Path
- p.rel = data.Rel
-}
-
-func (p basePath) GobEncode() ([]byte, error) {
- return gobtools.CustomGobEncode[basePathGob](&p)
-}
-
-func (p *basePath) GobDecode(data []byte) error {
- return gobtools.CustomGobDecode[basePathGob](data, p)
-}
-
func (p basePath) Ext() string {
return filepath.Ext(p.path)
}
@@ -1263,6 +1227,8 @@ func (p basePath) withoutRel() basePath {
}
// SourcePath is a Path representing a file path rooted from SrcDir
+//
+// @auto-generate: gob
type SourcePath struct {
basePath
}
@@ -1496,6 +1462,8 @@ func (p SourcePath) join(ctx PathContext, paths ...string) SourcePath {
}
// OutputPath is a Path representing an intermediates file path rooted from the build directory
+//
+// @auto-generate: gob
type OutputPath struct {
basePath
@@ -1505,34 +1473,6 @@ type OutputPath struct {
fullPath string
}
-type outputPathGob struct {
- BasePath basePath
- OutDir string
- FullPath string
-}
-
-func (p *OutputPath) ToGob() *outputPathGob {
- return &outputPathGob{
- BasePath: p.basePath,
- OutDir: p.outDir,
- FullPath: p.fullPath,
- }
-}
-
-func (p *OutputPath) FromGob(data *outputPathGob) {
- p.basePath = data.BasePath
- p.outDir = data.OutDir
- p.fullPath = data.FullPath
-}
-
-func (p OutputPath) GobEncode() ([]byte, error) {
- return gobtools.CustomGobEncode[outputPathGob](&p)
-}
-
-func (p *OutputPath) GobDecode(data []byte) error {
- return gobtools.CustomGobDecode[outputPathGob](data, p)
-}
-
func (p OutputPath) withRel(rel string) OutputPath {
p.basePath = p.basePath.withRel(rel)
p.fullPath = filepath.Join(p.fullPath, rel)
@@ -1572,6 +1512,7 @@ var _ WritablePath = OutputPath{}
var _ objPathProvider = OutputPath{}
// toolDepPath is a Path representing a dependency of the build tool.
+// @auto-generate: gob
type toolDepPath struct {
basePath
}
@@ -1690,10 +1631,10 @@ func PathForModuleSrc(ctx ModuleMissingDepsPathContext, pathComponents ...string
} else {
reportPathError(ctx, err)
}
- return nil
+ return pathForModuleSrc(ctx, "Missing_PathForModuleSrc_file")
} else if len(paths) == 0 {
ReportPathErrorf(ctx, "%q produced no files, expected exactly one", p)
- return nil
+ return pathForModuleSrc(ctx, "Missing_PathForModuleSrc_file")
} else if len(paths) > 1 {
ReportPathErrorf(ctx, "%q produced %d files, expected exactly one", p, len(paths))
}
@@ -1771,6 +1712,7 @@ func (p SourcePath) resPathWithName(ctx ModuleOutPathContext, name string) Modul
}
// ModuleOutPath is a Path representing a module's output directory.
+// @auto-generate: gob
type ModuleOutPath struct {
OutputPath
}
@@ -1814,6 +1756,7 @@ func PathForModuleOut(ctx ModuleOutPathContext, paths ...string) ModuleOutPath {
// ModuleGenPath is a Path representing the 'gen' directory in a module's output
// directory. Mainly used for generated sources.
+// @auto-generate: gob
type ModuleGenPath struct {
ModuleOutPath
}
@@ -1864,6 +1807,7 @@ func (p ModuleGenPath) objPathWithExt(ctx ModuleOutPathContext, subdir, ext stri
// ModuleObjPath is a Path representing the 'obj' directory in a module's output
// directory. Used for compiled objects.
+// @auto-generate: gob
type ModuleObjPath struct {
ModuleOutPath
}
@@ -1888,6 +1832,7 @@ func PathForModuleObj(ctx ModuleOutPathContext, pathComponents ...string) Module
// ModuleResPath is a a Path representing the 'res' directory in a module's
// output directory.
+// @auto-generate: gob
type ModuleResPath struct {
ModuleOutPath
}
@@ -1912,6 +1857,8 @@ func PathForModuleRes(ctx ModuleOutPathContext, pathComponents ...string) Module
}
// InstallPath is a Path representing a installed file path rooted from the build directory
+//
+// @auto-generate: gob
type InstallPath struct {
basePath
@@ -1930,43 +1877,6 @@ type InstallPath struct {
fullPath string
}
-type installPathGob struct {
- BasePath basePath
- SoongOutDir string
- PartitionDir string
- Partition string
- MakePath bool
- FullPath string
-}
-
-func (p *InstallPath) ToGob() *installPathGob {
- return &installPathGob{
- BasePath: p.basePath,
- SoongOutDir: p.soongOutDir,
- PartitionDir: p.partitionDir,
- Partition: p.partition,
- MakePath: p.makePath,
- FullPath: p.fullPath,
- }
-}
-
-func (p *InstallPath) FromGob(data *installPathGob) {
- p.basePath = data.BasePath
- p.soongOutDir = data.SoongOutDir
- p.partitionDir = data.PartitionDir
- p.partition = data.Partition
- p.makePath = data.MakePath
- p.fullPath = data.FullPath
-}
-
-func (p InstallPath) GobEncode() ([]byte, error) {
- return gobtools.CustomGobEncode[installPathGob](&p)
-}
-
-func (p *InstallPath) GobDecode(data []byte) error {
- return gobtools.CustomGobDecode[installPathGob](data, p)
-}
-
// Will panic if called from outside a test environment.
func ensureTestOnly() {
if PrefixInList(os.Args, "-test.") {
@@ -2303,6 +2213,7 @@ func PathForPhony(ctx PathContext, phony string) WritablePath {
return PhonyPath{basePath{phony, ""}}
}
+// @auto-generate: gob
type PhonyPath struct {
basePath
}
@@ -2333,6 +2244,7 @@ func (p PhonyPath) ReplaceExtension(ctx PathContext, ext string) OutputPath {
var _ Path = PhonyPath{}
var _ WritablePath = PhonyPath{}
+// @auto-generate: gob
type testPath struct {
basePath
}
@@ -2578,6 +2490,7 @@ func absolutePath(path string) string {
// The data file should be installed (copied from `<SrcPath>`) to
// `<install_root>/<RelativeInstallPath>/<filename>`, or
// `<install_root>/<filename>` if RelativeInstallPath is empty.
+// @auto-generate: gob
type DataPath struct {
// The path of the data file that should be copied into the data directory
SrcPath Path
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-20 03:12:26 +0000