com.google.j2cl.transpiler.frontend.jdt.KtInteropAnnotationUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of frontend-jdt Show documentation
There is a newer version: v20241110-1
/*
 * Copyright 2016 Google Inc.
 *
 * 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.j2cl.transpiler.frontend.jdt;

import static com.google.j2cl.transpiler.frontend.common.FrontendConstants.KT_DISABLED_ANNOTATION_NAME;
import static com.google.j2cl.transpiler.frontend.common.FrontendConstants.KT_IN_ANNOTATION_NAME;
import static com.google.j2cl.transpiler.frontend.common.FrontendConstants.KT_NAME_ANNOTATION_NAME;
import static com.google.j2cl.transpiler.frontend.common.FrontendConstants.KT_NATIVE_ANNOTATION_NAME;
import static com.google.j2cl.transpiler.frontend.common.FrontendConstants.KT_OBJECTIVE_C_NAME;
import static com.google.j2cl.transpiler.frontend.common.FrontendConstants.KT_OUT_ANNOTATION_NAME;
import static com.google.j2cl.transpiler.frontend.common.FrontendConstants.KT_PROPERTY_ANNOTATION_NAME;
import static com.google.j2cl.transpiler.frontend.common.FrontendConstants.KT_THROWS_ANNOTATION_NAME;
import static com.google.j2cl.transpiler.frontend.common.FrontendConstants.SUPPRESS_WARNINGS_ANNOTATION_NAME;
import static com.google.j2cl.transpiler.frontend.jdt.JdtAnnotationUtils.findAnnotationBindingByName;
import static com.google.j2cl.transpiler.frontend.jdt.JdtAnnotationUtils.getAnnotationBinding;
import static com.google.j2cl.transpiler.frontend.jdt.JdtAnnotationUtils.getStringAttribute;

import org.eclipse.jdt.core.dom.IAnnotationBinding;
import org.eclipse.jdt.core.dom.ITypeBinding;
import org.eclipse.jdt.core.dom.PackageDeclaration;

/** Utility methods to get information about Kotlin Interop annotations. */
public class KtInteropAnnotationUtils {
  private KtInteropAnnotationUtils() {}

  public static IAnnotationBinding getKtNameAnnotation(IAnnotationBinding[] annotationBindings) {
    return findAnnotationBindingByName(annotationBindings, KT_NAME_ANNOTATION_NAME);
  }

  public static IAnnotationBinding getKtNativeAnnotation(IAnnotationBinding[] annotationBindings) {
    return findAnnotationBindingByName(annotationBindings, KT_NATIVE_ANNOTATION_NAME);
  }

  public static IAnnotationBinding getKtPropertyAnnotation(
      IAnnotationBinding[] annotationBindings) {
    return findAnnotationBindingByName(annotationBindings, KT_PROPERTY_ANNOTATION_NAME);
  }

  public static IAnnotationBinding getKtDisabledAnnotation(
      IAnnotationBinding[] annotationBindings) {
    return findAnnotationBindingByName(annotationBindings, KT_DISABLED_ANNOTATION_NAME);
  }

  /** The namespace specified on a package, type, method or field. */
  public static String getKtObjectiveCName(ITypeBinding typeBinding) {
    return getKtObjectiveCName(getKtObjectiveCNameAnnotation(typeBinding.getAnnotations()));
  }

  public static String getKtObjectiveCName(IAnnotationBinding annotationBinding) {
    return getStringAttribute(annotationBinding, "value");
  }

  public static String getKtObjectiveCName(PackageDeclaration packageDeclaration) {
    return getKtObjectiveCName(
        getAnnotationBinding(packageDeclaration, KtInteropAnnotationUtils::isKtObjectiveCName));
  }

  public static boolean isKtObjectiveCName(IAnnotationBinding annotationBinding) {
    return annotationBinding.getAnnotationType().getQualifiedName().equals(KT_OBJECTIVE_C_NAME);
  }

  public static IAnnotationBinding getKtObjectiveCNameAnnotation(
      IAnnotationBinding[] annotationBindings) {
    return findAnnotationBindingByName(annotationBindings, KT_OBJECTIVE_C_NAME);
  }

  public static IAnnotationBinding getKtInAnnotation(IAnnotationBinding[] annotationBindings) {
    return findAnnotationBindingByName(annotationBindings, KT_IN_ANNOTATION_NAME);
  }

  public static IAnnotationBinding getKtOutAnnotation(IAnnotationBinding[] annotationBindings) {
    return findAnnotationBindingByName(annotationBindings, KT_OUT_ANNOTATION_NAME);
  }

  public static IAnnotationBinding getKtThrowsAnnotation(IAnnotationBinding[] annotationBindings) {
    return findAnnotationBindingByName(annotationBindings, KT_THROWS_ANNOTATION_NAME);
  }

  public static IAnnotationBinding getSuppressWarningsAnnotation(
      IAnnotationBinding[] annotationBindings) {
    return findAnnotationBindingByName(annotationBindings, SUPPRESS_WARNINGS_ANNOTATION_NAME);
  }
}