// Copyright 2015 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. // A genrule module takes a list of source files ("srcs" property), an optional // list of tools ("tools" property), and a command line ("cmd" property), to // generate output files ("out" property). package genrule import ( "fmt" "io" "path/filepath" "strconv" "strings" "android/soong/bazel/cquery" "github.com/google/blueprint" "github.com/google/blueprint/bootstrap" "github.com/google/blueprint/proptools" "android/soong/android" "android/soong/bazel" ) func init() { RegisterGenruleBuildComponents(android.InitRegistrationContext) } // Test fixture preparer that will register most genrule build components. // // Singletons and mutators should only be added here if they are needed for a majority of genrule // module types, otherwise they should be added under a separate preparer to allow them to be // selected only when needed to reduce test execution time. // // Module types do not have much of an overhead unless they are used so this should include as many // module types as possible. The exceptions are those module types that require mutators and/or // singletons in order to function in which case they should be kept together in a separate // preparer. var PrepareForTestWithGenRuleBuildComponents = android.GroupFixturePreparers( android.FixtureRegisterWithContext(RegisterGenruleBuildComponents), ) // Prepare a fixture to use all genrule module types, mutators and singletons fully. // // This should only be used by tests that want to run with as much of the build enabled as possible. var PrepareForIntegrationTestWithGenrule = android.GroupFixturePreparers( PrepareForTestWithGenRuleBuildComponents, ) func RegisterGenruleBuildComponents(ctx android.RegistrationContext) { ctx.RegisterModuleType("genrule_defaults", defaultsFactory) ctx.RegisterModuleType("gensrcs", GenSrcsFactory) ctx.RegisterModuleType("genrule", GenRuleFactory) ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) { ctx.BottomUp("genrule_tool_deps", toolDepsMutator).Parallel() }) } var ( pctx = android.NewPackageContext("android/soong/genrule") // Used by gensrcs when there is more than 1 shard to merge the outputs // of each shard into a zip file. gensrcsMerge = pctx.AndroidStaticRule("gensrcsMerge", blueprint.RuleParams{ Command: "${soongZip} -o ${tmpZip} @${tmpZip}.rsp && ${zipSync} -d ${genDir} ${tmpZip}", CommandDeps: []string{"${soongZip}", "${zipSync}"}, Rspfile: "${tmpZip}.rsp", RspfileContent: "${zipArgs}", }, "tmpZip", "genDir", "zipArgs") ) func init() { pctx.Import("android/soong/android") pctx.HostBinToolVariable("soongZip", "soong_zip") pctx.HostBinToolVariable("zipSync", "zipsync") } type SourceFileGenerator interface { GeneratedSourceFiles() android.Paths GeneratedHeaderDirs() android.Paths GeneratedDeps() android.Paths } // Alias for android.HostToolProvider // Deprecated: use android.HostToolProvider instead. type HostToolProvider interface { android.HostToolProvider } type hostToolDependencyTag struct { blueprint.BaseDependencyTag android.LicenseAnnotationToolchainDependencyTag label string } func (t hostToolDependencyTag) AllowDisabledModuleDependency(target android.Module) bool { // Allow depending on a disabled module if it's replaced by a prebuilt // counterpart. We get the prebuilt through android.PrebuiltGetPreferred in // GenerateAndroidBuildActions. return target.IsReplacedByPrebuilt() } var _ android.AllowDisabledModuleDependency = (*hostToolDependencyTag)(nil) type generatorProperties struct { // The command to run on one or more input files. Cmd supports substitution of a few variables. // // Available variables for substitution: // // $(location): the path to the first entry in tools or tool_files. // $(location