AAPT2: Remove resources that define locales but no default values. (34a1687a) · Commits · e / os / android_frameworks_base

tools/aapt2/Android.bp

+1 −0

Original line number	Diff line number	Diff line
		@@ -101,6 +101,7 @@ cc_library_host_static {
		"io/ZipArchive.cpp",
		"link/AutoVersioner.cpp",
		"link/ManifestFixer.cpp",
		"link/NoDefaultResourceRemover.cpp",
		"link/ProductFilter.cpp",
		"link/PrivateAttributeMover.cpp",
		"link/ReferenceLinker.cpp",

tools/aapt2/ResourceTable.cpp

+13 −12

Original line number	Diff line number	Diff line
		@@ -162,7 +162,7 @@ struct ConfigKey {
		const StringPiece& product;
		};

		bool ltConfigKeyRef(const std::unique_ptr<ResourceConfigValue>& lhs, const ConfigKey& rhs) {
		bool lt_config_key_ref(const std::unique_ptr<ResourceConfigValue>& lhs, const ConfigKey& rhs) {
		int cmp = lhs->config.compare(*rhs.config);
		if (cmp == 0) {
		cmp = StringPiece(lhs->product).compare(rhs.product);
		@@ -172,8 +172,8 @@ bool ltConfigKeyRef(const std::unique_ptr<ResourceConfigValue>& lhs, const Confi

		ResourceConfigValue* ResourceEntry::FindValue(const ConfigDescription& config,
		const StringPiece& product) {
		auto iter =
		std::lower_bound(values.begin(), values.end(), ConfigKey{&config, product}, ltConfigKeyRef);
		auto iter = std::lower_bound(values.begin(), values.end(), ConfigKey{&config, product},
		lt_config_key_ref);
		if (iter != values.end()) {
		ResourceConfigValue* value = iter->get();
		if (value->config == config && StringPiece(value->product) == product) {
		@@ -185,8 +185,8 @@ ResourceConfigValue* ResourceEntry::FindValue(const ConfigDescription& config,

		ResourceConfigValue* ResourceEntry::FindOrCreateValue(const ConfigDescription& config,
		const StringPiece& product) {
		auto iter =
		std::lower_bound(values.begin(), values.end(), ConfigKey{&config, product}, ltConfigKeyRef);
		auto iter = std::lower_bound(values.begin(), values.end(), ConfigKey{&config, product},
		lt_config_key_ref);
		if (iter != values.end()) {
		ResourceConfigValue* value = iter->get();
		if (value->config == config && StringPiece(value->product) == product) {
		@@ -220,15 +220,16 @@ std::vector<ResourceConfigValue*> ResourceEntry::FindAllValues(const ConfigDescr
		return results;
		}

		std::vector<ResourceConfigValue*> ResourceEntry::FindValuesIf(
		const std::function<bool(ResourceConfigValue*)>& f) {
		std::vector<ResourceConfigValue*> results;
		for (auto& configValue : values) {
		if (f(configValue.get())) {
		results.push_back(configValue.get());
		bool ResourceEntry::HasDefaultValue() const {
		const ConfigDescription& default_config = ConfigDescription::DefaultConfig();

		// The default config should be at the top of the list, since the list is sorted.
		for (auto& config_value : values) {
		if (config_value->config == default_config) {
		return true;
		}
		}
		return results;
		return false;
		}

		// The default handler for collisions.

tools/aapt2/ResourceTable.h

+15 −2

Original line number	Diff line number	Diff line
		@@ -104,13 +104,26 @@ class ResourceEntry {
		explicit ResourceEntry(const android::StringPiece& name) : name(name.to_string()) {}

		ResourceConfigValue* FindValue(const ConfigDescription& config);

		ResourceConfigValue* FindValue(const ConfigDescription& config,
		const android::StringPiece& product);

		ResourceConfigValue* FindOrCreateValue(const ConfigDescription& config,
		const android::StringPiece& product);
		std::vector<ResourceConfigValue*> FindAllValues(const ConfigDescription& config);
		std::vector<ResourceConfigValue*> FindValuesIf(
		const std::function<bool(ResourceConfigValue*)>& f);

		template <typename Func>
		std::vector<ResourceConfigValue*> FindValuesIf(Func f) {
		std::vector<ResourceConfigValue*> results;
		for (auto& config_value : values) {
		if (f(config_value.get())) {
		results.push_back(config_value.get());
		}
		}
		return results;
		}

		bool HasDefaultValue() const;

		private:
		DISALLOW_COPY_AND_ASSIGN(ResourceEntry);

tools/aapt2/cmd/Link.cpp

+9 −0

Original line number	Diff line number	Diff line
		@@ -55,6 +55,7 @@
		#include "java/ProguardRules.h"
		#include "link/Linkers.h"
		#include "link/ManifestFixer.h"
		#include "link/NoDefaultResourceRemover.h"
		#include "link/ReferenceLinker.h"
		#include "link/TableMerger.h"
		#include "link/XmlCompatVersioner.h"
		@@ -1785,6 +1786,14 @@ class LinkCommand {
		util::make_unique<FeatureSplitSymbolTableDelegate>(context_));
		}

		// Before we process anything, remove the resources whose default values don't exist.
		// We want to force any references to these to fail the build.
		if (!NoDefaultResourceRemover{}.Consume(context_, &final_table_)) {
		context_->GetDiagnostics()->Error(DiagMessage()
		<< "failed removing resources with no defaults");
		return 1;
		}

		ReferenceLinker linker;
		if (!linker.Consume(context_, &final_table_)) {
		context_->GetDiagnostics()->Error(DiagMessage() << "failed linking references");

tools/aapt2/link/NoDefaultResourceRemover.cpp

0 → 100644

+83 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2018 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.
		*/

		#include "link/NoDefaultResourceRemover.h"

		#include <algorithm>

		#include "ResourceTable.h"

		namespace aapt {

		static bool IsDefaultConfigRequired(const ConfigDescription& config) {
		// We don't want to be overzealous with resource removal, so have strict requirements.
		// If a resource defines a value for a locale-only configuration, the default configuration is
		// required.
		if (ConfigDescription::DefaultConfig().diff(config) == ConfigDescription::CONFIG_LOCALE) {
		return true;
		}
		return false;
		}

		static bool KeepResource(const std::unique_ptr<ResourceEntry>& entry) {
		if (entry->visibility.level == Visibility::Level::kPublic) {
		// Removing a public API without the developer knowing is bad, so just leave this here for now.
		return true;
		}

		if (entry->HasDefaultValue()) {
		// There is a default value, no removal needed.
		return true;
		}

		// There is no default value defined, check if removal is required.
		for (const auto& config_value : entry->values) {
		if (IsDefaultConfigRequired(config_value->config)) {
		return false;
		}
		}
		return true;
		}

		bool NoDefaultResourceRemover::Consume(IAaptContext* context, ResourceTable* table) {
		const ConfigDescription default_config = ConfigDescription::DefaultConfig();
		for (auto& pkg : table->packages) {
		for (auto& type : pkg->types) {
		const auto end_iter = type->entries.end();
		const auto new_end_iter =
		std::stable_partition(type->entries.begin(), end_iter, KeepResource);
		for (auto iter = new_end_iter; iter != end_iter; ++iter) {
		const ResourceName name(pkg->name, type->type, (*iter)->name);
		IDiagnostics* diag = context->GetDiagnostics();
		diag->Warn(DiagMessage() << "removing resource " << name
		<< " without required default value");
		if (context->IsVerbose()) {
		diag->Note(DiagMessage() << " did you forget to remove all definitions?");
		for (const auto& config_value : (*iter)->values) {
		if (config_value->value != nullptr) {
		diag->Note(DiagMessage(config_value->value->GetSource()) << "defined here");
		}
		}
		}
		}

		type->entries.erase(new_end_iter, type->entries.end());
		}
		}
		return true;
		}

		} // namespace aapt