AAPT2: Remove resources that define locales but no default values.
According to our docs:
https://developer.android.com/guide/topics/resources/localization.html#defaults-r-important
Some resources *require* that there is a default definition. So far,
the pain is felt when doing translations for strings that have been
renamed, etc.
This CL strips out resources that don't have a default value and define
a resource for a locale. This is conservative, but should be expanded
to other configuration properties moving forward.
Bug: 36572857
Test: make aapt2_tests
Change-Id: Ife94a1f8a2ee221f8532ffa856541a9c8c4e7143
diff --git a/tools/aapt2/link/NoDefaultResourceRemover.cpp b/tools/aapt2/link/NoDefaultResourceRemover.cpp
new file mode 100644
index 0000000..cfb4b26
--- /dev/null
+++ b/tools/aapt2/link/NoDefaultResourceRemover.cpp
@@ -0,0 +1,83 @@
+/*
+ * 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
diff --git a/tools/aapt2/link/NoDefaultResourceRemover.h b/tools/aapt2/link/NoDefaultResourceRemover.h
new file mode 100644
index 0000000..7582ef3
--- /dev/null
+++ b/tools/aapt2/link/NoDefaultResourceRemover.h
@@ -0,0 +1,45 @@
+/*
+ * 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.
+ */
+
+#ifndef AAPT_LINK_NODEFAULTRESOURCEREMOVER_H
+#define AAPT_LINK_NODEFAULTRESOURCEREMOVER_H
+
+#include "android-base/macros.h"
+
+#include "process/IResourceTableConsumer.h"
+
+namespace aapt {
+
+// Removes any resource for which there exists no definition for the default configuration, where
+// for that resource type, a definition is required.
+//
+// The obvious example is when defining localized strings. If a string in the default configuration
+// has its name changed, the translations for that string won't be changed but will still cause
+// the generated R class to contain the old string name. This will cause breakages in apps that
+// still rely on the old name when the translations are updated.
+class NoDefaultResourceRemover : public IResourceTableConsumer {
+ public:
+ NoDefaultResourceRemover() = default;
+
+ bool Consume(IAaptContext* context, ResourceTable* table) override;
+
+ private:
+ DISALLOW_COPY_AND_ASSIGN(NoDefaultResourceRemover);
+};
+
+} // namespace aapt
+
+#endif // AAPT_LINK_NODEFAULTRESOURCEREMOVER_H
diff --git a/tools/aapt2/link/NoDefaultResourceRemover_test.cpp b/tools/aapt2/link/NoDefaultResourceRemover_test.cpp
new file mode 100644
index 0000000..943709a
--- /dev/null
+++ b/tools/aapt2/link/NoDefaultResourceRemover_test.cpp
@@ -0,0 +1,49 @@
+/*
+ * 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 "test/Test.h"
+
+namespace aapt {
+
+TEST(NoDefaultResourceRemoverTest, RemoveEntryWithNoDefaultAndOnlyLocales) {
+ std::unique_ptr<IAaptContext> context = test::ContextBuilder().Build();
+ std::unique_ptr<ResourceTable> table =
+ test::ResourceTableBuilder()
+ .SetPackageId("android", 0x01)
+ .AddSimple("android:string/foo")
+ .AddSimple("android:string/foo", test::ParseConfigOrDie("en-rGB"))
+ .AddSimple("android:string/foo", test::ParseConfigOrDie("fr-rFR"))
+ .AddSimple("android:string/bar", test::ParseConfigOrDie("en-rGB"))
+ .AddSimple("android:string/bar", test::ParseConfigOrDie("fr-rFR"))
+ .AddSimple("android:string/bat", test::ParseConfigOrDie("en-rGB-xhdpi"))
+ .AddSimple("android:string/bat", test::ParseConfigOrDie("fr-rFR-hdpi"))
+ .AddSimple("android:string/baz", test::ParseConfigOrDie("en-rGB"))
+ .AddSimple("android:string/baz", test::ParseConfigOrDie("fr-rFR"))
+ .SetSymbolState("android:string/baz", ResourceId(0x01020002), Visibility::Level::kPublic)
+ .Build();
+
+ NoDefaultResourceRemover remover;
+ ASSERT_TRUE(remover.Consume(context.get(), table.get()));
+
+ EXPECT_TRUE(table->FindResource(test::ParseNameOrDie("android:string/foo")));
+ EXPECT_FALSE(table->FindResource(test::ParseNameOrDie("android:string/bar")));
+ EXPECT_TRUE(table->FindResource(test::ParseNameOrDie("android:string/bat")));
+ EXPECT_TRUE(table->FindResource(test::ParseNameOrDie("android:string/baz")));
+}
+
+} // namespace aapt