// Copyright 2017 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 python

// This file contains the "Base" module type for building Python program.

import (
 "fmt"
 "path/filepath"
 "regexp"
 "sort"
 "strings"

 "android/soong/cc"

 "github.com/google/blueprint"
 "github.com/google/blueprint/depset"
 "github.com/google/blueprint/proptools"

 "android/soong/android"
)

//go:generate go run ../../blueprint/gobtools/codegen

// @auto-generate: gob
type PythonLibraryInfo struct {
 SrcsPathMappings   depset.DepSet[pathMapping]
 DataPathMappings   depset.DepSet[pathMapping]
 SrcsZip            depset.DepSet[android.Path]
 PrecompiledSrcsZip depset.DepSet[android.Path]
 PkgPath            string
 BundleSharedLibs   depset.DepSet[android.Path]
}

var PythonLibraryInfoProvider = blueprint.NewProvider[PythonLibraryInfo]()

// properties that apply to all python modules
type BaseProperties struct {
 // the package path prefix within the output artifact at which to place the source/data
 // files of the current module.
 // eg. Pkg_path = "a/b/c"; Other packages can reference this module by using
 // (from a.b.c import ...) statement.
 // if left unspecified, all the source/data files path is unchanged within zip file.
 Pkg_path *string

 // true, if the Python module is used internally, eg, Python std libs.
 Is_internal *bool

 // list of source (.py) files compatible both with Python2 and Python3 used to compile the
 // Python module.
 // srcs may reference the outputs of other modules that produce source files like genrule
 // or filegroup using the syntax ":module".
 // Srcs has to be non-empty.
 Srcs []string `android:"path,arch_variant"`

 // list of source files that should not be used to build the C/C++ module.
 // This is most useful in the arch/multilib variants to remove non-common files
 Exclude_srcs []string `android:"path,arch_variant"`

 // list of files or filegroup modules that provide data that should be installed alongside
 // the test. the file extension can be arbitrary except for (.py).
 Data []string `android:"path,arch_variant"`

 // Same as data, but will add dependencies on modules using the device's os variation and
 // the common arch variation. Useful for a host test that wants to embed a module built for
 // device.
 Device_common_data []string `android:"path_device_common"`

 // Same as data, but will add dependencies on modules via a device os variation and the
 // device's first supported arch's variation. Useful for a host test that wants to embed a
 // module built for device.
 Device_first_data []string `android:"path_device_first"`

 // list of java modules that provide data that should be installed alongside the test.
 Java_data []string

 // list of the Python libraries compatible both with Python2 and Python3.
 Libs []string `android:"arch_variant"`

 // list of shared libraries that should be packaged with the python code for this module.
 Shared_libs []string `android:"arch_variant"`

 // whether the binary is required to be built with an embedded python interpreter, defaults to
 // true. This allows taking the resulting binary outside of the build and running it on machines
 // that don't have python installed or may have an older version of python.
 Embedded_launcher *bool
}

// Used to store files of current module after expanding dependencies
// @auto-generate: gob
type pathMapping struct {
 module string
 dest   string
 src    android.Path
}

type PythonLibraryModule struct {
 android.ModuleBase
 android.DefaultableModuleBase

 properties      BaseProperties
 protoProperties android.ProtoProperties

 // initialize before calling Init
 hod      android.HostOrDeviceSupported
 multilib android.Multilib

 // the Python files of current module after expanding source dependencies.
 // pathMapping: <dest: runfile_path, src: source_path>
 srcsPathMappings []pathMapping

 // the data files of current module after expanding source dependencies.
 // pathMapping: <dest: runfile_path, src: source_path>
 dataPathMappings []pathMapping

 // The zip file containing the current module's source/data files.
 srcsZip android.Path

 // The zip file containing the current module's source/data files, with the
 // source files precompiled.
 precompiledSrcsZip android.Path

 sourceProperties android.SourceProperties

 // The shared libraries that should be bundled with the python code for
 // any standalone python binaries that depend on this module.
 bundleSharedLibs android.Paths

 libraryInfo PythonLibraryInfo
}

// newModule generates new Python base module
func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *PythonLibraryModule {
 return &PythonLibraryModule{
  hod:      hod,
  multilib: multilib,
 }
}

func (p *PythonLibraryModule) init() android.Module {
 p.AddProperties(&p.properties, &p.protoProperties, &p.sourceProperties)
 android.InitAndroidArchModule(p, p.hod, p.multilib)
 android.InitDefaultableModule(p)
 return p
}

// Python-specific tag to transfer information on the purpose of a dependency.
// This is used when adding a dependency on a module, which can later be accessed when visiting
// dependencies.
type dependencyTag struct {
 blueprint.BaseDependencyTag
 name string
}

// Python-specific tag that indicates that installed files of this module should depend on installed
// files of the dependency
type installDependencyTag struct {
 blueprint.BaseDependencyTag
 // embedding this struct provides the installation dependency requirement
 android.InstallAlwaysNeededDependencyTag
 name string
}

var (
 pythonLibTag = dependencyTag{name: "pythonLib"}
 javaDataTag  = dependencyTag{name: "javaData"}
 sharedLibTag = dependencyTag{name: "sharedLib"}
 // The python interpreter, with soong module name "py3-launcher" or "py3-launcher-autorun".
 launcherTag          = dependencyTag{name: "launcher"}
 launcherSharedLibTag = installDependencyTag{name: "launcherSharedLib"}
 // The python interpreter built for host so that we can precompile python sources.
 // This only works because the precompiled sources don't vary by architecture.
 // The soong module name is "py3-launcher".
 hostLauncherTag          = dependencyTag{name: "hostLauncher"}
 hostlauncherSharedLibTag = dependencyTag{name: "hostlauncherSharedLib"}
 hostStdLibTag            = dependencyTag{name: "hostStdLib"}
 pathComponentRegexp      = regexp.MustCompile(`^[a-zA-Z_][a-zA-Z0-9_-]*$`)
 pyExt                    = ".py"
 protoExt                 = ".proto"
 internalPath             = "internal"
)

func anyHasExt(paths []string, ext string) bool {
 for _, p := range paths {
  if filepath.Ext(p) == ext {
   return true
  }
 }

 return false
}

func (p *PythonLibraryModule) anySrcHasExt(ctx android.BottomUpMutatorContext, ext string) bool {
 return anyHasExt(p.properties.Srcs, ext)
}

// DepsMutator mutates dependencies for this module:
//   - handles proto dependencies,
//   - if required, specifies launcher and adds launcher dependencies,
//   - applies python version mutations to Python dependencies
func (p *PythonLibraryModule) DepsMutator(ctx android.BottomUpMutatorContext) {
 android.ProtoDeps(ctx, &p.protoProperties)

 // If sources contain a proto file, add dependency on libprotobuf-python
 if p.anySrcHasExt(ctx, protoExt) && p.Name() != "libprotobuf-python" {
  ctx.AddDependency(ctx.Module(), pythonLibTag, "libprotobuf-python")
 }

 // Add python library dependencies for this python version variation
 ctx.AddDependency(ctx.Module(), pythonLibTag, android.LastUniqueStrings(p.properties.Libs)...)

 // Emulate the data property for java_data but with the arch variation overridden to "common"
 // so that it can point to java modules.
 javaDataVariation := []blueprint.Variation{{"arch", android.Common.String()}}
 ctx.AddVariationDependencies(javaDataVariation, javaDataTag, p.properties.Java_data...)

 if ctx.Host() {
  ctx.AddVariationDependencies(ctx.Config().BuildOSTarget.Variations(), sharedLibTag, p.properties.Shared_libs...)
 } else if len(p.properties.Shared_libs) > 0 {
  ctx.PropertyErrorf("shared_libs", "shared_libs is not supported for device builds")
 }

 p.AddDepsOnPythonLauncherAndStdlib(ctx, hostStdLibTag, hostLauncherTag, hostlauncherSharedLibTag, false, ctx.Config().BuildOSTarget)

 ctx.AddHostToolDependencies("aprotoc", "soong_zip")
}

// AddDepsOnPythonLauncherAndStdlib will make the current module depend on the python stdlib,
// launcher (interpreter), and the launcher's shared libraries. If autorun is true, it will use
// the autorun launcher instead of the regular one. This function acceps a targetForDeps argument
// as the target to use for these dependencies. For embedded launcher python binaries, the launcher
// that will be embedded will be under the same target as the python module itself. But when
// precompiling python code, we need to get the python launcher built for host, even if we're
// compiling the python module for device, so we pass a different target to this function.
func (p *PythonLibraryModule) AddDepsOnPythonLauncherAndStdlib(ctx android.BottomUpMutatorContext,
 stdLibTag, launcherTag, launcherSharedLibTag blueprint.DependencyTag,
 autorun bool, targetForDeps android.Target) {
 var stdLib string
 var launcherModule string
 // Add launcher shared lib dependencies. Ideally, these should be
 // derived from the `shared_libs` property of the launcher. TODO: read these from
 // the python launcher itself using ctx.OtherModuleProvider() or similar on the result
 // of ctx.AddFarVariationDependencies()
 launcherSharedLibDeps := []string{
  "libsqlite",
 }
 // Add launcher-specific dependencies for bionic
 if targetForDeps.Os.Bionic() {
  launcherSharedLibDeps = append(launcherSharedLibDeps, "libc", "libdl", "libm")
 }
 if targetForDeps.Os == android.LinuxMusl && !ctx.Config().HostStaticBinaries() {
  launcherSharedLibDeps = append(launcherSharedLibDeps, "libc_musl")
 }

 var prebuiltStdLib bool
 if targetForDeps.Os.Bionic() {
  prebuiltStdLib = false
 } else if ctx.Config().VendorConfig("cpython3").Bool("force_build_host") {
  prebuiltStdLib = false
 } else {
  prebuiltStdLib = true
 }

 if prebuiltStdLib {
  stdLib = "py3-stdlib-prebuilt"
 } else {
  stdLib = "py3-stdlib"
 }

 launcherModule = "py3-launcher"
 if autorun {
  launcherModule = "py3-launcher-autorun"
 }
 if ctx.Config().HostStaticBinaries() && targetForDeps.Os == android.LinuxMusl {
  launcherModule += "-static"
 }
 if ctx.Device() {
  launcherSharedLibDeps = append(launcherSharedLibDeps, "liblog")
 }

 targetVariations := targetForDeps.Variations()
 if ctx.ModuleName() != stdLib {
  // Using AddFarVariationDependencies for all of these because they can be for a different
  // platform, like if the python module itself was being compiled for device, we may want
  // the python interpreter built for host so that we can precompile python sources.
  ctx.AddFarVariationDependencies(targetVariations, stdLibTag, stdLib)
 }
 ctx.AddFarVariationDependencies(targetVariations, launcherTag, launcherModule)
 ctx.AddFarVariationDependencies(targetVariations, launcherSharedLibTag, launcherSharedLibDeps...)
}

// GenerateAndroidBuildActions performs build actions common to all Python modules
func (p *PythonLibraryModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
 expandedSrcs := android.PathsForModuleSrcExcludes(ctx, p.properties.Srcs, p.properties.Exclude_srcs)
 // Keep before any early returns.
 ctx.SetTestModuleInfo(&android.TestModuleInformation{
  TestOnly:       Bool(p.sourceProperties.Test_only),
  TopLevelTarget: p.sourceProperties.Top_level_test_target,
 })

 // expand data files from "data" property.
 expandedData := android.PathsForModuleSrc(ctx, p.properties.Data)
 expandedData = append(expandedData, android.PathsForModuleSrc(ctx, p.properties.Device_common_data)...)
 expandedData = append(expandedData, android.PathsForModuleSrc(ctx, p.properties.Device_first_data)...)

 // Emulate the data property for java_data dependencies.
 for _, javaData := range ctx.GetDirectDepsProxyWithTag(javaDataTag) {
  expandedData = append(expandedData, android.OutputFilesForModule(ctx, javaData, "")...)
 }

 var directImplementationDeps android.Paths
 var transitiveImplementationDeps []depset.DepSet[android.Path]
 // we only collect dependencies tagged as python library deps
 ctx.VisitDirectDepsProxyWithTag(sharedLibTag, func(dep android.ModuleProxy) {
  sharedLibInfo, _ := android.OtherModuleProvider(ctx, dep, cc.SharedLibraryInfoProvider)
  if sharedLibInfo.SharedLibrary != nil {
   expandedData = append(expandedData, android.OutputFilesForModule(ctx, dep, "")...)
   directImplementationDeps = append(directImplementationDeps, android.OutputFilesForModule(ctx, dep, "")...)
   if info, ok := android.OtherModuleProvider(ctx, dep, cc.ImplementationDepInfoProvider); ok {
    transitiveImplementationDeps = append(transitiveImplementationDeps, info.ImplementationDeps)
    p.bundleSharedLibs = append(p.bundleSharedLibs, info.ImplementationDeps.ToList()...)
   }
  } else {
   ctx.PropertyErrorf("shared_libs", "%q of type %q is not supported", dep.Name(), ctx.OtherModuleType(dep))
  }
 })
 android.SetProvider(ctx, cc.ImplementationDepInfoProvider, &cc.ImplementationDepInfo{
  ImplementationDeps: depset.New(depset.PREORDER, directImplementationDeps, transitiveImplementationDeps),
 })

 // Validate pkg_path property
 pkgPath := String(p.properties.Pkg_path)
 if pkgPath != "" {
  // TODO: export validation from android/paths.go handling to replace this duplicated functionality
  pkgPath = filepath.Clean(String(p.properties.Pkg_path))
  if pkgPath == ".." || strings.HasPrefix(pkgPath, "../") ||
   strings.HasPrefix(pkgPath, "/") {
   ctx.PropertyErrorf("pkg_path",
    "%q must be a relative path contained in par file.",
    String(p.properties.Pkg_path))
   return
  }
 }
 // If property Is_internal is set, prepend pkgPath with internalPath
 if proptools.BoolDefault(p.properties.Is_internal, false) {
  pkgPath = filepath.Join(internalPath, pkgPath)
 }

 // generate src:destination path mappings for this module
 p.genModulePathMappings(ctx, pkgPath, expandedSrcs, expandedData)

 // generate the zipfile of all source and data files
 p.srcsZip = p.createSrcsZip(ctx, pkgPath)
 p.precompiledSrcsZip = p.precompileSrcs(ctx)

 srcsPathMappingsDepSetBuilder := depset.NewBuilder[pathMapping](depset.PREORDER).Direct(p.srcsPathMappings...)
 dataPathMappingsDepSetBuilder := depset.NewBuilder[pathMapping](depset.PREORDER).Direct(p.dataPathMappings...)
 srcsZipDepSetBuilder := depset.NewBuilder[android.Path](depset.PREORDER).Direct(p.srcsZip)
 precompiledSrcsZipDepSetBuilder := depset.NewBuilder[android.Path](depset.PREORDER).Direct(p.precompiledSrcsZip)
 bundledSharedLibsDepSetBuilder := depset.NewBuilder[android.Path](depset.PREORDER).Direct(p.bundleSharedLibs...)
 ctx.VisitDirectDepsProxyWithTag(pythonLibTag, func(dep android.ModuleProxy) {
  library, isLibrary := android.OtherModuleProvider(ctx, dep, PythonLibraryInfoProvider)
  _, isBinary := android.OtherModuleProvider(ctx, dep, PythonBinaryInfoProvider)
  if !isLibrary || isBinary {
   ctx.PropertyErrorf("libs", "the dependency %q is not Python library!", ctx.OtherModuleName(dep))
   return
  }

  srcsPathMappingsDepSetBuilder.Transitive(library.SrcsPathMappings)
  dataPathMappingsDepSetBuilder.Transitive(library.DataPathMappings)
  srcsZipDepSetBuilder.Transitive(library.SrcsZip)
  precompiledSrcsZipDepSetBuilder.Transitive(library.PrecompiledSrcsZip)
  bundledSharedLibsDepSetBuilder.Transitive(library.BundleSharedLibs)
 })

 p.libraryInfo = PythonLibraryInfo{
  SrcsPathMappings:   srcsPathMappingsDepSetBuilder.Build(),
  DataPathMappings:   dataPathMappingsDepSetBuilder.Build(),
  SrcsZip:            srcsZipDepSetBuilder.Build(),
  PkgPath:            String(p.properties.Pkg_path),
  PrecompiledSrcsZip: precompiledSrcsZipDepSetBuilder.Build(),
  BundleSharedLibs:   bundledSharedLibsDepSetBuilder.Build(),
 }
 android.SetProvider(ctx, PythonLibraryInfoProvider, p.libraryInfo)
}

func isValidPythonPath(path string) error {
 identifiers := strings.Split(strings.TrimSuffix(path, filepath.Ext(path)), "/")
 for _, token := range identifiers {
  if !pathComponentRegexp.MatchString(token) {
   return fmt.Errorf("the path %q contains invalid subpath %q. "+
    "Subpaths must be at least one character long. "+
    "The first character must an underscore or letter. "+
    "Following characters may be any of: letter, digit, underscore, hyphen.",
    path, token)
  }
 }
 return nil
}

// For this module, generate unique pathMappings: <dest: runfiles_path, src: source_path>
// for python/data files expanded from properties.
func (p *PythonLibraryModule) genModulePathMappings(ctx android.ModuleContext, pkgPath string,
 expandedSrcs, expandedData android.Paths) {
 // fetch <runfiles_path, source_path> pairs from "src" and "data" properties to
 // check current module duplicates.
 destToPySrcs := make(map[string]pathMapping)
 destToPyData := make(map[string]pathMapping)

 // Disable path checks for the stdlib, as it includes a "." in the version string
 isInternal := proptools.BoolDefault(p.properties.Is_internal, false)

 for _, s := range expandedSrcs {
  if s.Ext() != pyExt && s.Ext() != protoExt {
   ctx.PropertyErrorf("srcs", "found non (.py|.proto) file: %q!", s.String())
   continue
  }
  runfilesPath := filepath.Join(pkgPath, s.Rel())
  if !isInternal {
   if err := isValidPythonPath(runfilesPath); err != nil {
    ctx.PropertyErrorf("srcs", err.Error())
   }
  }
  path := pathMapping{module: ctx.ModuleName(), dest: runfilesPath, src: s}
  if !checkForDuplicateOutputPath(ctx, destToPySrcs, path) {
   p.srcsPathMappings = append(p.srcsPathMappings, path)
  }
 }

 for _, d := range expandedData {
  if d.Ext() == pyExt {
   ctx.PropertyErrorf("data", "found (.py) file: %q!", d.String())
   continue
  }
  runfilesPath := filepath.Join(pkgPath, d.Rel())
  path := pathMapping{module: ctx.ModuleName(), dest: runfilesPath, src: d}
  if !checkForDuplicateOutputPath(ctx, destToPyData, path) {
   p.dataPathMappings = append(p.dataPathMappings, path)
  }
 }
}

// createSrcsZip registers build actions to zip current module's sources and data.
func (p *PythonLibraryModule) createSrcsZip(ctx android.ModuleContext, pkgPath string) android.Path {
 relativeRootMap := make(map[string]android.Paths)
 var protoSrcs android.Paths
 addPathMapping := func(path pathMapping) {
  relativeRoot := strings.TrimSuffix(path.src.String(), path.src.Rel())
  relativeRootMap[relativeRoot] = append(relativeRootMap[relativeRoot], path.src)
 }

 // "srcs" or "data" properties may contain filegroups so it might happen that
 // the root directory for each source path is different.
 for _, path := range p.srcsPathMappings {
  // handle proto sources separately
  if path.src.Ext() == protoExt {
   protoSrcs = append(protoSrcs, path.src)
  } else {
   addPathMapping(path)
  }
 }
 for _, path := range p.dataPathMappings {
  addPathMapping(path)
 }

 var zips android.Paths
 if len(protoSrcs) > 0 {
  protoFlags := android.GetProtoFlags(ctx, &p.protoProperties)
  protoFlags.OutTypeFlag = "--python_out"

  if pkgPath != "" {
   pkgPathStagingDir := android.PathForModuleGen(ctx, "protos_staged_for_pkg_path")
   rule := android.NewRuleBuilder(pctx, ctx)
   var stagedProtoSrcs android.Paths
   for _, srcFile := range protoSrcs {
    stagedProtoSrc := pkgPathStagingDir.Join(ctx, pkgPath, srcFile.Rel())
    rule.Command().BuiltTool("cp").Flag("-f").Input(srcFile).Output(stagedProtoSrc)
    stagedProtoSrcs = append(stagedProtoSrcs, stagedProtoSrc)
   }
   rule.Build("stage_protos_for_pkg_path", "Stage protos for pkg_path")
   protoSrcs = stagedProtoSrcs
  }

  // Srcs are compiled independently, and may depend on each other.
  protoFlags.Deps = append(protoFlags.Deps, protoSrcs...)

  for _, srcFile := range protoSrcs {
   zip := genProto(ctx, srcFile, protoFlags)
   zips = append(zips, zip)
  }
 }

 if len(relativeRootMap) > 0 {
  // in order to keep stable order of soong_zip params, we sort the keys here.
  roots := android.SortedKeys(relativeRootMap)

  // Use -symlinks=false so that the symlinks in the bazel output directory are followed
  parArgs := []string{"-symlinks=false"}
  if pkgPath != "" {
   // use package path as path prefix
   parArgs = append(parArgs, `-P `+pkgPath)
  }
  paths := android.Paths{}
  for _, root := range roots {
   // specify relative root of file in following -f arguments
   parArgs = append(parArgs, `-C `+root)
   for _, path := range relativeRootMap[root] {
    parArgs = append(parArgs, `-f `+path.String())
    paths = append(paths, path)
   }
  }

  origSrcsZip := android.PathForModuleOut(ctx, ctx.ModuleName()+".py.srcszip")
  ctx.Build(pctx, android.BuildParams{
   Rule:        zip,
   Description: "python library archive",
   Output:      origSrcsZip,
   // as zip rule does not use $in, there is no real need to distinguish between Inputs and Implicits
   Implicits: paths,
   Args: map[string]string{
    "args": strings.Join(parArgs, " "),
   },
  })
  zips = append(zips, origSrcsZip)
 }
 // we may have multiple zips due to separate handling of proto source files
 if len(zips) == 1 {
  return zips[0]
 } else {
  combinedSrcsZip := android.PathForModuleOut(ctx, ctx.ModuleName()+".srcszip")
  ctx.Build(pctx, android.BuildParams{
   Rule:        combineZip,
   Description: "combine python library archive",
   Output:      combinedSrcsZip,
   Inputs:      zips,
  })
  return combinedSrcsZip
 }
}

func (p *PythonLibraryModule) precompileSrcs(ctx android.ModuleContext) android.Path {
 // To precompile the python sources, we need a python interpreter and stdlib built
 // for host. We then use those to compile the python sources, which may be used on either
 // host of device. Python bytecode is architecture agnostic, so we're essentially
 // "cross compiling" for device here purely by virtue of host and device python bytecode
 // being the same.
 var stdLib android.Path
 var stdLibPkg string
 var launcher android.Path
 if proptools.BoolDefault(p.properties.Is_internal, false) {
  stdLib = p.srcsZip
  stdLibPkg = String(p.properties.Pkg_path)
 } else {
  ctx.VisitDirectDepsProxyWithTag(hostStdLibTag, func(module android.ModuleProxy) {
   if dep, ok := android.OtherModuleProvider(ctx, module, PythonLibraryInfoProvider); ok {
    stdlibPrecompiledSrcsZip := dep.PrecompiledSrcsZip.ToList()
    if len(stdlibPrecompiledSrcsZip) == 1 {
     stdLib = stdlibPrecompiledSrcsZip[0]
    } else {
     ctx.ModuleErrorf("expected one source zip from stdlib dependency %s, got %d",
      ctx.OtherModuleName(module), len(stdlibPrecompiledSrcsZip))
     stdLib = android.PathForModuleOut(ctx, "missing_stdlib")
    }
    stdLibPkg = dep.PkgPath
   }
  })
 }
 ctx.VisitDirectDepsProxyWithTag(hostLauncherTag, func(module android.ModuleProxy) {
  if dep, ok := android.OtherModuleProvider(ctx, module, cc.LinkableInfoProvider); ok {
   optionalLauncher := dep.OutputFile
   if optionalLauncher.Valid() {
    launcher = optionalLauncher.Path()
   }
  }
 })
 var launcherSharedLibs android.Paths
 var ldLibraryPath []string
 ctx.VisitDirectDepsProxyWithTag(hostlauncherSharedLibTag, func(module android.ModuleProxy) {
  if dep, ok := android.OtherModuleProvider(ctx, module, cc.LinkableInfoProvider); ok {
   optionalPath := dep.OutputFile
   if optionalPath.Valid() {
    launcherSharedLibs = append(launcherSharedLibs, optionalPath.Path())
    ldLibraryPath = append(ldLibraryPath, filepath.Dir(optionalPath.Path().String()))
   }
  }
 })

 out := android.PathForModuleOut(ctx, ctx.ModuleName()+".srcszipprecompiled")
 if stdLib == nil || launcher == nil {
  // This shouldn't happen in a real build because we'll error out when adding dependencies
  // on the stdlib and launcher if they don't exist. But some tests set
  // AllowMissingDependencies.
  return out
 }
 ctx.Build(pctx, android.BuildParams{
  Rule:        precompile,
  Input:       p.srcsZip,
  Output:      out,
  Implicits:   launcherSharedLibs,
  Description: "Precompile the python sources of " + ctx.ModuleName(),
  Args: map[string]string{
   "stdlibZip":     stdLib.String(),
   "stdlibPkg":     stdLibPkg,
   "launcher":      launcher.String(),
   "ldLibraryPath": strings.Join(ldLibraryPath, ":"),
  },
 })
 return out
}

// checkDuplicatePaths checks for source/data files for duplicate paths
// for module and its transitive dependencies and collects list of data/source file
// zips for transitive dependencies.
func (p *PythonLibraryModule) checkDuplicatePaths(ctx android.ModuleContext) {
 // fetch <runfiles_path, source_path> pairs from "src" and "data" properties to
 // check duplicates.
 destToPySrcs := make(map[string]pathMapping)
 destToPyData := make(map[string]pathMapping)

 for _, path := range p.libraryInfo.SrcsPathMappings.ToList() {
  checkForDuplicateOutputPath(ctx, destToPySrcs, path)
 }
 for _, path := range p.libraryInfo.DataPathMappings.ToList() {
  checkForDuplicateOutputPath(ctx, destToPyData, path)
 }
}

func (p *PythonLibraryModule) zipSharedLibs(ctx android.ModuleContext, bundleSharedLibs android.Paths) android.Path {
 // sort the paths to keep the output deterministic
 sort.Slice(bundleSharedLibs, func(i, j int) bool {
  return bundleSharedLibs[i].String() < bundleSharedLibs[j].String()
 })

 parArgs := []string{"-symlinks=false", "-P lib64"}
 paths := android.Paths{}
 for _, path := range bundleSharedLibs {
  // specify relative root of file in following -f arguments
  parArgs = append(parArgs, `-C `+filepath.Dir(path.String()))
  parArgs = append(parArgs, `-f `+path.String())
  paths = append(paths, path)
 }
 srcsZip := android.PathForModuleOut(ctx, ctx.ModuleName()+".sharedlibs.srcszip")
 ctx.Build(pctx, android.BuildParams{
  Rule:        zip,
  Description: "bundle shared libraries for python binary",
  Output:      srcsZip,
  Implicits:   paths,
  Args: map[string]string{
   "args": strings.Join(parArgs, " "),
  },
 })
 return srcsZip
}

// chckForDuplicateOutputPath checks whether outputPath has already been included in map m, which
// would result in two files being placed in the same location.
// If there is a duplicate path, an error is thrown and true is returned
// Otherwise, outputPath: srcPath is added to m and returns false
func checkForDuplicateOutputPath(ctx android.ModuleContext, m map[string]pathMapping, path pathMapping) bool {
 if oldPathMapping, found := m[path.dest]; found {
  ctx.ModuleErrorf("found two files to be placed at the same location within zip %q."+
   " First file: in module %s at path %q."+
   " Second file: in module %s at path %q.",
   path.dest, oldPathMapping.module, oldPathMapping.src, path.module, path.src)
  return true
 }
 m[path.dest] = path

 return false
}

// InstallInData returns true as Python is not supported in the system partition
func (p *PythonLibraryModule) InstallInData() bool {
 return true
}

var Bool = proptools.Bool
var BoolDefault = proptools.BoolDefault
var String = proptools.String