Pass config files to metalava (27819366) · Commits · e / os / android_build_soong

java/droidstubs.go

+28 −2

Original line number	Diff line number	Diff line
		@@ -197,6 +197,10 @@ type DroidstubsProperties struct {
		// a list of aconfig_declarations module names that the stubs generated in this module
		// depend on.
		Aconfig_declarations []string

		// List of hard coded filegroups containing Metalava config files that are passed to every
		// Metalava invocation that this module performs. See addMetalavaConfigFilesToCmd.
		ConfigFiles []string `android:"path" blueprint:"mutated"`
		}

		// Used by xsd_config
		@@ -259,6 +263,7 @@ func DroidstubsFactory() android.Module {

		module.AddProperties(&module.properties,
		&module.Javadoc.properties)
		module.properties.ConfigFiles = getMetalavaConfigFilegroupReference()
		module.initModuleAndImport(module)

		InitDroiddocModule(module, android.HostAndDeviceSupported)
		@@ -279,6 +284,7 @@ func DroidstubsHostFactory() android.Module {
		module.AddProperties(&module.properties,
		&module.Javadoc.properties)

		module.properties.ConfigFiles = getMetalavaConfigFilegroupReference()
		InitDroiddocModule(module, android.HostSupported)
		return module
		}
		@@ -694,7 +700,7 @@ func metalavaUseRbe(ctx android.ModuleContext) bool {
		}

		func metalavaCmd(ctx android.ModuleContext, rule *android.RuleBuilder, srcs android.Paths,
		srcJarList android.Path, homeDir android.WritablePath, params stubsCommandConfigParams) *android.RuleBuilderCommand {
		srcJarList android.Path, homeDir android.WritablePath, params stubsCommandConfigParams, configFiles android.Paths) *android.RuleBuilderCommand {
		rule.Command().Text("rm -rf").Flag(homeDir.String())
		rule.Command().Text("mkdir -p").Flag(homeDir.String())

		@@ -738,9 +744,26 @@ func metalavaCmd(ctx android.ModuleContext, rule *android.RuleBuilder, srcs andr

		cmd.Flag(config.MetalavaFlags)

		addMetalavaConfigFilesToCmd(cmd, configFiles)

		return cmd
		}

		// MetalavaConfigFilegroup is the name of the filegroup in build/soong/java/metalava that lists
		// the configuration files to pass to Metalava.
		const MetalavaConfigFilegroup = "metalava-config-files"

		// Get a reference to the MetalavaConfigFilegroup suitable for use in a property.
		func getMetalavaConfigFilegroupReference() []string {
		return []string{":" + MetalavaConfigFilegroup}
		}

		// addMetalavaConfigFilesToCmd adds --config-file options to use the config files list in the
		// MetalavaConfigFilegroup filegroup.
		func addMetalavaConfigFilesToCmd(cmd *android.RuleBuilderCommand, configFiles android.Paths) {
		cmd.FlagForEachInput("--config-file ", configFiles)
		}

		// Pass flagged apis related flags to metalava. When aconfig_declarations property is not
		// defined for a module, simply revert all flagged apis annotations. If aconfig_declarations
		// property is defined, apply transformations and only revert the flagged apis that are not
		@@ -812,7 +835,10 @@ func (d Droidstubs) commonMetalavaStubCmd(ctx android.ModuleContext, rule andr
		srcJarList := zipSyncCmd(ctx, rule, params.srcJarDir, d.Javadoc.srcJars)

		homeDir := android.PathForModuleOut(ctx, params.stubConfig.stubsType.String(), "home")
		cmd := metalavaCmd(ctx, rule, d.Javadoc.srcFiles, srcJarList, homeDir, params.stubConfig)

		configFiles := android.PathsForModuleSrc(ctx, d.properties.ConfigFiles)

		cmd := metalavaCmd(ctx, rule, d.Javadoc.srcFiles, srcJarList, homeDir, params.stubConfig, configFiles)
		cmd.Implicits(d.Javadoc.implicits)

		d.stubsFlags(ctx, cmd, params.stubsDir, params.stubConfig.stubsType, params.stubConfig.checkApi)

java/java.go

+13 −4

Original line number	Diff line number	Diff line
		@@ -2039,12 +2039,17 @@ type JavaApiLibraryProperties struct {
		// List of aconfig_declarations module names that the stubs generated in this module
		// depend on.
		Aconfig_declarations []string

		// List of hard coded filegroups containing Metalava config files that are passed to every
		// Metalava invocation that this module performs. See addMetalavaConfigFilesToCmd.
		ConfigFiles []string `android:"path" blueprint:"mutated"`
		}

		func ApiLibraryFactory() android.Module {
		module := &ApiLibrary{}
		android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibCommon)
		module.AddProperties(&module.properties)
		module.properties.ConfigFiles = getMetalavaConfigFilegroupReference()
		android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibCommon)
		module.initModuleAndImport(module)
		android.InitDefaultableModule(module)
		return module
		@@ -2060,7 +2065,7 @@ func (al *ApiLibrary) StubsJar() android.Path {

		func metalavaStubCmd(ctx android.ModuleContext, rule *android.RuleBuilder,
		srcs android.Paths, homeDir android.WritablePath,
		classpath android.Paths) *android.RuleBuilderCommand {
		classpath android.Paths, configFiles android.Paths) *android.RuleBuilderCommand {
		rule.Command().Text("rm -rf").Flag(homeDir.String())
		rule.Command().Text("mkdir -p").Flag(homeDir.String())

		@@ -2099,6 +2104,8 @@ func metalavaStubCmd(ctx android.ModuleContext, rule *android.RuleBuilder,
		FlagWithArg("--hide ", "InvalidNullabilityOverride").
		FlagWithArg("--hide ", "ChangedDefault")

		addMetalavaConfigFilesToCmd(cmd, configFiles)

		if len(classpath) == 0 {
		// The main purpose of the `--api-class-resolution api` option is to force metalava to ignore
		// classes on the classpath when an API file contains missing classes. However, as this command
		@@ -2310,7 +2317,9 @@ func (al *ApiLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
		ctx.ModuleErrorf("Error: %s has an empty api file.", ctx.ModuleName())
		}

		cmd := metalavaStubCmd(ctx, rule, srcFiles, homeDir, systemModulesPaths)
		configFiles := android.PathsForModuleSrc(ctx, al.properties.ConfigFiles)

		cmd := metalavaStubCmd(ctx, rule, srcFiles, homeDir, systemModulesPaths, configFiles)

		al.stubsFlags(ctx, cmd, stubsDir)

java/metalava/Android.bp

0 → 100644

+18 −0

Original line number	Diff line number	Diff line
		// Copyright (C) 2024 The Android Open Source Project
		//
		// 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.

		filegroup {
		name: "metalava-config-files",
		srcs: ["*-config.xml"],
		}

java/metalava/OWNERS

0 → 100644

+3 −0

Original line number	Diff line number	Diff line
		# Bug component: 463936

		file:platform/tools/metalava:/OWNERS

java/metalava/main-config.xml

0 → 100644

+19 −0

Original line number	Diff line number	Diff line
		<!--
		~ Copyright (C) 2024 The Android Open Source Project
		~
		~ 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.
		-->

		<config xmlns="http://www.google.com/tools/metalava/config"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xsi:schemaLocation="http://www.google.com/tools/metalava/config ../../../../tools/metalava/metalava/src/main/resources/schemas/config.xsd"/>