123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171 |
- // Copyright 2018 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 xml
- import (
- "android/soong/android"
- "android/soong/bazel"
- "android/soong/etc"
- "github.com/google/blueprint"
- "github.com/google/blueprint/proptools"
- )
- // prebuilt_etc_xml installs an xml file under <partition>/etc/<subdir>.
- // It also optionally validates the xml file against the schema.
- var (
- pctx = android.NewPackageContext("android/soong/xml")
- xmllintDtd = pctx.AndroidStaticRule("xmllint-dtd",
- blueprint.RuleParams{
- Command: `$XmlLintCmd --dtdvalid $dtd $in > /dev/null && touch -a $out`,
- CommandDeps: []string{"$XmlLintCmd"},
- Restat: true,
- },
- "dtd")
- xmllintXsd = pctx.AndroidStaticRule("xmllint-xsd",
- blueprint.RuleParams{
- Command: `$XmlLintCmd --schema $xsd $in > /dev/null && touch -a $out`,
- CommandDeps: []string{"$XmlLintCmd"},
- Restat: true,
- },
- "xsd")
- xmllintMinimal = pctx.AndroidStaticRule("xmllint-minimal",
- blueprint.RuleParams{
- Command: `$XmlLintCmd $in > /dev/null && touch -a $out`,
- CommandDeps: []string{"$XmlLintCmd"},
- Restat: true,
- })
- )
- func init() {
- registerXmlBuildComponents(android.InitRegistrationContext)
- pctx.HostBinToolVariable("XmlLintCmd", "xmllint")
- }
- func registerXmlBuildComponents(ctx android.RegistrationContext) {
- ctx.RegisterModuleType("prebuilt_etc_xml", PrebuiltEtcXmlFactory)
- }
- type prebuiltEtcXmlProperties struct {
- // Optional DTD that will be used to validate the xml file.
- Schema *string `android:"path"`
- }
- type prebuiltEtcXml struct {
- android.BazelModuleBase
- etc.PrebuiltEtc
- properties prebuiltEtcXmlProperties
- }
- func (p *prebuiltEtcXml) timestampFilePath(ctx android.ModuleContext) android.WritablePath {
- return android.PathForModuleOut(ctx, p.PrebuiltEtc.SourceFilePath(ctx).Base()+"-timestamp")
- }
- func (p *prebuiltEtcXml) GenerateAndroidBuildActions(ctx android.ModuleContext) {
- p.PrebuiltEtc.GenerateAndroidBuildActions(ctx)
- if p.properties.Schema != nil {
- schema := android.PathForModuleSrc(ctx, proptools.String(p.properties.Schema))
- switch schema.Ext() {
- case ".dtd":
- ctx.Build(pctx, android.BuildParams{
- Rule: xmllintDtd,
- Description: "xmllint-dtd",
- Input: p.PrebuiltEtc.SourceFilePath(ctx),
- Output: p.timestampFilePath(ctx),
- Implicit: schema,
- Args: map[string]string{
- "dtd": schema.String(),
- },
- })
- break
- case ".xsd":
- ctx.Build(pctx, android.BuildParams{
- Rule: xmllintXsd,
- Description: "xmllint-xsd",
- Input: p.PrebuiltEtc.SourceFilePath(ctx),
- Output: p.timestampFilePath(ctx),
- Implicit: schema,
- Args: map[string]string{
- "xsd": schema.String(),
- },
- })
- break
- default:
- ctx.PropertyErrorf("schema", "not supported extension: %q", schema.Ext())
- }
- } else {
- // when schema is not specified, just check if the xml is well-formed
- ctx.Build(pctx, android.BuildParams{
- Rule: xmllintMinimal,
- Description: "xmllint-minimal",
- Input: p.PrebuiltEtc.SourceFilePath(ctx),
- Output: p.timestampFilePath(ctx),
- })
- }
- p.SetAdditionalDependencies([]android.Path{p.timestampFilePath(ctx)})
- }
- func PrebuiltEtcXmlFactory() android.Module {
- module := &prebuiltEtcXml{}
- module.AddProperties(&module.properties)
- etc.InitPrebuiltEtcModule(&module.PrebuiltEtc, "etc")
- // This module is device-only
- android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
- android.InitBazelModule(module)
- return module
- }
- type bazelPrebuiltEtcXmlAttributes struct {
- Src bazel.LabelAttribute
- Filename bazel.LabelAttribute
- Dir string
- Installable bazel.BoolAttribute
- Filename_from_src bazel.BoolAttribute
- Schema *string
- }
- func (p *prebuiltEtcXml) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
- baseAttrs := p.PrebuiltEtc.Bp2buildHelper(ctx)
- var schema *string
- if p.properties.Schema != nil {
- schema = p.properties.Schema
- }
- attrs := &bazelPrebuiltEtcXmlAttributes{
- Src: baseAttrs.Src,
- Filename: baseAttrs.Filename,
- Dir: baseAttrs.Dir,
- Installable: baseAttrs.Installable,
- Filename_from_src: baseAttrs.Filename_from_src,
- Schema: schema,
- }
- props := bazel.BazelTargetModuleProperties{
- Rule_class: "prebuilt_xml",
- Bzl_load_location: "//build/bazel/rules/prebuilt_xml.bzl",
- }
- ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: p.Name()}, attrs)
- }
|