diff options
author | Jooyung Han <jooyung@google.com> | 2022-01-18 16:00:51 +0900 |
---|---|---|
committer | Jooyung Han <jooyung@google.com> | 2022-01-24 15:24:37 +0900 |
commit | e6a38f76b1c5d0753c43bc24e9d7b50a64e4a589 (patch) | |
tree | 6c23aabc04c354abaa75390efa9102cdfd2f1d38 | |
parent | 051699933f9f043d23f5b32d57abaf4de276e19b (diff) | |
download | aidl-e6a38f76b1c5d0753c43bc24e9d7b50a64e4a589.tar.gz |
Add @JavaSuppressLint
This is a kind of passthrough annotations for the Java backend. But
adding it as an AIDL annotation is much simpler since it also affects
--checkapi. (JavaSuppressLint can be ignored when checking backward
compatibility.)
Bug: 193460475
Test: aidl_unittests
Merged-In: I640e2268b7bdfeb7c630e3620f5eea20ef354679
Change-Id: I640e2268b7bdfeb7c630e3620f5eea20ef354679
(cherry picked from commit c2bc750f87418979a4e1e8c14c64b51c153d2ea2)
-rw-r--r-- | aidl_api/aidl-test-versioned-interface/current/android/aidl/versioned/tests/Foo.aidl | 1 | ||||
-rw-r--r-- | aidl_checkapi.cpp | 1 | ||||
-rw-r--r-- | aidl_language.cpp | 4 | ||||
-rw-r--r-- | aidl_language.h | 1 | ||||
-rw-r--r-- | aidl_unittest.cpp | 30 | ||||
-rw-r--r-- | generate_java.cpp | 7 | ||||
-rw-r--r-- | tests/versioned/android/aidl/versioned/tests/Foo.aidl | 1 |
7 files changed, 45 insertions, 0 deletions
diff --git a/aidl_api/aidl-test-versioned-interface/current/android/aidl/versioned/tests/Foo.aidl b/aidl_api/aidl-test-versioned-interface/current/android/aidl/versioned/tests/Foo.aidl index dad05e61..7e5e4dff 100644 --- a/aidl_api/aidl-test-versioned-interface/current/android/aidl/versioned/tests/Foo.aidl +++ b/aidl_api/aidl-test-versioned-interface/current/android/aidl/versioned/tests/Foo.aidl @@ -17,6 +17,7 @@ // later when a module using the interface is updated, e.g., Mainline modules. package android.aidl.versioned.tests; +@JavaSuppressLint(value={"NewApi"}) parcelable Foo { int intDefault42 = 42; } diff --git a/aidl_checkapi.cpp b/aidl_checkapi.cpp index b132494f..8e183742 100644 --- a/aidl_checkapi.cpp +++ b/aidl_checkapi.cpp @@ -88,6 +88,7 @@ static vector<string> get_strict_annotations(const AidlAnnotatable& node) { AidlAnnotation::Type::JAVA_DERIVE, AidlAnnotation::Type::JAVA_DEFAULT, AidlAnnotation::Type::JAVA_ONLY_IMMUTABLE, + AidlAnnotation::Type::JAVA_SUPPRESS_LINT, // @Backing for a enum type is checked by the enum checker AidlAnnotation::Type::BACKING, // @RustDerive doesn't affect read/write diff --git a/aidl_language.cpp b/aidl_language.cpp index 22104774..733d5e2d 100644 --- a/aidl_language.cpp +++ b/aidl_language.cpp @@ -134,6 +134,10 @@ const std::vector<AidlAnnotation::Schema>& AidlAnnotation::AllSchemas() { CONTEXT_TYPE_STRUCTURED_PARCELABLE | CONTEXT_TYPE_UNION | CONTEXT_TYPE_UNSTRUCTURED_PARCELABLE, {}}, + {AidlAnnotation::Type::JAVA_SUPPRESS_LINT, + "JavaSuppressLint", + CONTEXT_ALL, + {{"value", kStringArrayType, /* required= */ true}}}, {AidlAnnotation::Type::FIXED_SIZE, "FixedSize", CONTEXT_TYPE_STRUCTURED_PARCELABLE, {}}, {AidlAnnotation::Type::DESCRIPTOR, "Descriptor", diff --git a/aidl_language.h b/aidl_language.h index 36c50664..69cf38f9 100644 --- a/aidl_language.h +++ b/aidl_language.h @@ -211,6 +211,7 @@ class AidlAnnotation : public AidlNode { JAVA_DERIVE, JAVA_DEFAULT, JAVA_ONLY_IMMUTABLE, + JAVA_SUPPRESS_LINT, FIXED_SIZE, DESCRIPTOR, RUST_DERIVE, diff --git a/aidl_unittest.cpp b/aidl_unittest.cpp index f825cfd2..eef607fd 100644 --- a/aidl_unittest.cpp +++ b/aidl_unittest.cpp @@ -2238,6 +2238,21 @@ TEST_F(AidlTestCompatibleChanges, CompatibleExplicitDefaults) { EXPECT_TRUE(::android::aidl::check_api(options_, io_delegate_)); } +TEST_F(AidlTestCompatibleChanges, NewJavaSuppressLint) { + io_delegate_.SetFileContents("old/p/IFoo.aidl", + "package p;" + "interface IFoo {" + " void foo(int a);" + "}"); + io_delegate_.SetFileContents("new/p/IFoo.aidl", + "package p;" + "@JavaSuppressLint({\"NewApi\"})" + "interface IFoo {" + " void foo(int a);" + "}"); + EXPECT_TRUE(::android::aidl::check_api(options_, io_delegate_)); +} + class AidlTestIncompatibleChanges : public AidlTest { protected: Options options_ = Options::From("aidl --checkapi old new"); @@ -3064,6 +3079,21 @@ TEST_F(AidlTest, ParseRustDerive) { EXPECT_EQ(0, ::android::aidl::compile_aidl(java_options, io_delegate_)); } +TEST_F(AidlTest, JavaSuppressLint) { + io_delegate_.SetFileContents("a/IFoo.aidl", R"(package a; + @JavaSuppressLint({"NewApi"}) + interface IFoo { + })"); + + Options options = Options::From("aidl --lang=java -o out a/IFoo.aidl"); + CaptureStderr(); + EXPECT_TRUE(compile_aidl(options, io_delegate_)); + EXPECT_EQ(GetCapturedStderr(), ""); + string code; + EXPECT_TRUE(io_delegate_.GetWrittenContents("out/a/IFoo.java", &code)); + EXPECT_THAT(code, HasSubstr("@android.annotation.SuppressLint(value = {\"NewApi\"})")); +} + class AidlOutputPathTest : public AidlTest { protected: void SetUp() override { diff --git a/generate_java.cpp b/generate_java.cpp index f3b7a937..e1d82988 100644 --- a/generate_java.cpp +++ b/generate_java.cpp @@ -966,6 +966,13 @@ std::vector<std::string> generate_java_annotations(const AidlAnnotatable& a) { if (annotation.GetType() == AidlAnnotation::Type::JAVA_PASSTHROUGH) { result.emplace_back(annotation.ParamValue<std::string>("annotation").value()); } + if (annotation.GetType() == AidlAnnotation::Type::JAVA_SUPPRESS_LINT) { + std::vector<std::string> values; + for (const auto& [name, value] : annotation.AnnotationParams(ConstantValueDecorator)) { + values.emplace_back(name + " = " + value); + } + result.emplace_back("@android.annotation.SuppressLint(" + Join(values, ", ") + ")"); + } } return result; diff --git a/tests/versioned/android/aidl/versioned/tests/Foo.aidl b/tests/versioned/android/aidl/versioned/tests/Foo.aidl index acf76209..3651ed88 100644 --- a/tests/versioned/android/aidl/versioned/tests/Foo.aidl +++ b/tests/versioned/android/aidl/versioned/tests/Foo.aidl @@ -1,5 +1,6 @@ package android.aidl.versioned.tests; +@JavaSuppressLint(value={"NewApi"}) parcelable Foo { // V1 is empty // V2 |