Adds @SwiftUnavailable annotation to annotate methods with NS_SWIFT_UNAVAILABLE macro.

tomball · copybara-github · commit 5151005bb74e · 2021-03-29T18:46:31.000-07:00
PiperOrigin-RevId: 365712527
diff --git a/annotations/src/main/java/com/google/j2objc/annotations/SwiftUnavailable.java b/annotations/src/main/java/com/google/j2objc/annotations/SwiftUnavailable.java
@@ -0,0 +1,40 @@
+/*
+ * 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 com.google.j2objc.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marks a declaration as not suitable for Swift importing. This
+ * adds an <code>NS_SWIFT_UNAVAILABLE</code> annotation, as described:
+ * https://developer.apple.com/documentation/swift/objective-c_and_c_code_customization/making_objective-c_apis_unavailable_in_swift
+ */
+@Documented
+@Target({
+    ElementType.CONSTRUCTOR,
+    ElementType.FIELD,
+    ElementType.METHOD,
+    ElementType.TYPE
+})
+@Retention(RetentionPolicy.SOURCE)
+public @interface SwiftUnavailable {
+
+  String value() default "unavailable";
+
+}
diff --git a/translator/src/main/java/com/google/devtools/j2objc/gen/TypeDeclarationGenerator.java b/translator/src/main/java/com/google/devtools/j2objc/gen/TypeDeclarationGenerator.java
@@ -37,11 +37,13 @@
 import com.google.devtools.j2objc.util.TranslationUtil;
 import com.google.devtools.j2objc.util.TypeUtil;
 import com.google.devtools.j2objc.util.UnicodeUtils;
+import com.google.j2objc.annotations.SwiftUnavailable;
 import java.lang.reflect.Modifier;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.Iterator;
 import java.util.List;
+import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.Element;
 import javax.lang.model.element.ExecutableElement;
 import javax.lang.model.element.TypeElement;
@@ -610,6 +612,12 @@ private void printMethodDeclaration(MethodDeclaration m, boolean isCompanionClas
     if (m.isUnavailable()) {
       print(" NS_UNAVAILABLE");
     }
+    AnnotationMirror annotation =
+        ElementUtil.getAnnotation(m.getExecutableElement(), SwiftUnavailable.class);
+    if (annotation != null) {
+      String message = (String) ElementUtil.getAnnotationValue(annotation, "value");
+      print(" NS_SWIFT_UNAVAILABLE(\"" + message + "\")");
+    }
     println(";");
   }
 
@@ -635,6 +643,7 @@ private boolean hasDeprecated(List<Annotation> annotations) {
     return false;
   }
 
+
   @Override
   protected void printNativeDeclaration(NativeDeclaration declaration) {
     String code = declaration.getHeaderCode();
diff --git a/translator/src/test/java/com/google/devtools/j2objc/gen/TypeDeclarationGeneratorTest.java b/translator/src/test/java/com/google/devtools/j2objc/gen/TypeDeclarationGeneratorTest.java
@@ -782,4 +782,15 @@ public void testConstructorMapping() throws IOException {
       fail("No mapping found for MyClass() constructor");
     }
   }
+
+  public void testSwiftUnavailableAnnotation() throws IOException {
+    String source = String.join("\n",
+        "import com.google.j2objc.annotations.SwiftUnavailable;",
+        "class Test {",
+        "  @SwiftUnavailable(\"test message\")",
+        "  public void test() {}",
+        "}");
+    String translation = translateSourceFile(source, "Test", "Test.h");
+    assertTranslation(translation, "- (void)test NS_SWIFT_UNAVAILABLE(\"test message\");");
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -782,4 +782,15 @@ public void testConstructorMapping() throws IOException {`
`782`	`782`	`fail("No mapping found for MyClass() constructor");`
`783`	`783`	`}`
`784`	`784`	`}`
	`785`	`+`
	`786`	`+ public void testSwiftUnavailableAnnotation() throws IOException {`
	`787`	`+ String source = String.join("\n",`
	`788`	`+ "import com.google.j2objc.annotations.SwiftUnavailable;",`
	`789`	`+ "class Test {",`
	`790`	`+ " @SwiftUnavailable(\"test message\")",`
	`791`	`+ " public void test() {}",`
	`792`	`+ "}");`
	`793`	`+ String translation = translateSourceFile(source, "Test", "Test.h");`
	`794`	`+ assertTranslation(translation, "- (void)test NS_SWIFT_UNAVAILABLE(\"test message\");");`
	`795`	`+ }`
`785`	`796`	`}`