001 /*
002 * Copyright 2010-2015 JetBrains s.r.o.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017 package org.jetbrains.kotlin.load.java;
018
019 import kotlin.SetsKt;
020 import org.jetbrains.annotations.NotNull;
021 import org.jetbrains.kotlin.name.ClassId;
022 import org.jetbrains.kotlin.name.FqName;
023 import org.jetbrains.kotlin.name.Name;
024 import org.jetbrains.kotlin.resolve.jvm.JvmClassName;
025
026 import java.util.Arrays;
027 import java.util.HashSet;
028 import java.util.Set;
029
030 public final class JvmAnnotationNames {
031 public static final FqName KOTLIN_CLASS = new FqName("kotlin.jvm.internal.KotlinClass");
032 public static final FqName KOTLIN_PACKAGE = new FqName("kotlin.jvm.internal.KotlinPackage");
033 public static final FqName KOTLIN_FILE_FACADE = new FqName("kotlin.jvm.internal.KotlinFileFacade");
034 public static final FqName KOTLIN_MULTIFILE_CLASS = new FqName("kotlin.jvm.internal.KotlinMultifileClass");
035 public static final FqName KOTLIN_MULTIFILE_CLASS_PART = new FqName("kotlin.jvm.internal.KotlinMultifileClassPart");
036 public static final FqName KOTLIN_SYNTHETIC_CLASS = new FqName("kotlin.jvm.internal.KotlinSyntheticClass");
037 public static final FqName KOTLIN_FUNCTION = new FqName("kotlin.jvm.internal.KotlinFunction");
038 public static final FqName KOTLIN_INTERFACE_DEFAULT_IMPLS = new FqName("kotlin.jvm.internal.KotlinInterfaceDefaultImpls");
039 public static final FqName KOTLIN_LOCAL_CLASS = new FqName("kotlin.jvm.internal.KotlinLocalClass");
040
041 public static final FqName JAVA_LANG_DEPRECATED = new FqName("java.lang.Deprecated");
042
043 public static final FqName KOTLIN_DELEGATED_METHOD = new FqName("kotlin.jvm.internal.KotlinDelegatedMethod");
044 public static final String IMPLEMENTATION_CLASS_NAME_FIELD_NAME = "implementationClassName";
045
046 public static final FqName KOTLIN_SIGNATURE = new FqName("kotlin.jvm.KotlinSignature");
047 public static final FqName OLD_KOTLIN_SIGNATURE = new FqName("jet.runtime.typeinfo.KotlinSignature");
048
049 public static final String VERSION_FIELD_NAME = "version";
050 public static final String FILE_PART_CLASS_NAMES_FIELD_NAME = "filePartClassNames";
051 public static final String MULTIFILE_CLASS_NAME_FIELD_NAME = "multifileClassName";
052 public static final String DATA_FIELD_NAME = "data";
053 public static final String STRINGS_FIELD_NAME = "strings";
054 public static final String MODULE_NAME_FIELD_NAME = "moduleName";
055 public static final Name DEFAULT_ANNOTATION_MEMBER_NAME = Name.identifier("value");
056 public static final Name DEPRECATED_ANNOTATION_MESSAGE = Name.identifier("message");
057 public static final Name TARGET_ANNOTATION_MEMBER_NAME = Name.identifier("allowedTargets");
058
059 public static final FqName TARGET_ANNOTATION = new FqName("java.lang.annotation.Target");
060 public static final FqName RETENTION_ANNOTATION = new FqName("java.lang.annotation.Retention");
061 public static final FqName DOCUMENTED_ANNOTATION = new FqName("java.lang.annotation.Documented");
062
063 public static final FqName JETBRAINS_NOT_NULL_ANNOTATION = new FqName("org.jetbrains.annotations.NotNull");
064 public static final FqName JETBRAINS_NULLABLE_ANNOTATION = new FqName("org.jetbrains.annotations.Nullable");
065 public static final FqName JETBRAINS_MUTABLE_ANNOTATION = new FqName("org.jetbrains.annotations.Mutable");
066 public static final FqName JETBRAINS_READONLY_ANNOTATION = new FqName("org.jetbrains.annotations.ReadOnly");
067
068 public static final FqName PURELY_IMPLEMENTS_ANNOTATION = new FqName("kotlin.jvm.PurelyImplements");
069
070 // Just for internal use: there is no such real classes in bytecode
071 public static final FqName ENHANCED_NULLABILITY_ANNOTATION = new FqName("kotlin.jvm.internal.EnhancedNullability");
072 public static final FqName ENHANCED_MUTABILITY_ANNOTATION = new FqName("kotlin.jvm.internal.EnhancedMutability");
073
074 public static final String OLD_ABI_VERSION_FIELD_NAME = "abiVersion";
075
076 // When these annotations appear on a declaration, they are copied to the _type_ of the declaration, becoming type annotations
077 // See also DescriptorRendererOptions#excludedTypeAnnotationClasses
078 public static final Set<FqName> ANNOTATIONS_COPIED_TO_TYPES = SetsKt.setOf(
079 JETBRAINS_READONLY_ANNOTATION,
080 JETBRAINS_MUTABLE_ANNOTATION,
081 JETBRAINS_NOT_NULL_ANNOTATION,
082 JETBRAINS_NULLABLE_ANNOTATION
083 );
084
085 private static final Set<JvmClassName> SPECIAL_ANNOTATIONS = new HashSet<JvmClassName>();
086 private static final Set<JvmClassName> NULLABILITY_ANNOTATIONS = new HashSet<JvmClassName>();
087 private static final Set<JvmClassName> SPECIAL_META_ANNOTATIONS = new HashSet<JvmClassName>();
088 static {
089 for (FqName fqName : Arrays.asList(
090 KOTLIN_CLASS, KOTLIN_PACKAGE, KOTLIN_SIGNATURE, KOTLIN_SYNTHETIC_CLASS, KOTLIN_INTERFACE_DEFAULT_IMPLS, KOTLIN_LOCAL_CLASS
091 )) {
092 SPECIAL_ANNOTATIONS.add(JvmClassName.byFqNameWithoutInnerClasses(fqName));
093 }
094
095 for (FqName fqName : Arrays.asList(JETBRAINS_NOT_NULL_ANNOTATION, JETBRAINS_NULLABLE_ANNOTATION)) {
096 NULLABILITY_ANNOTATIONS.add(JvmClassName.byFqNameWithoutInnerClasses(fqName));
097 }
098
099 for (FqName fqName : Arrays.asList(TARGET_ANNOTATION, RETENTION_ANNOTATION, DOCUMENTED_ANNOTATION)) {
100 SPECIAL_META_ANNOTATIONS.add(JvmClassName.byFqNameWithoutInnerClasses(fqName));
101 }
102 }
103
104 public static boolean isSpecialAnnotation(@NotNull ClassId classId, boolean javaSpecificAnnotationsAreSpecial) {
105 JvmClassName className = JvmClassName.byClassId(classId);
106 return (javaSpecificAnnotationsAreSpecial
107 && (NULLABILITY_ANNOTATIONS.contains(className) || SPECIAL_META_ANNOTATIONS.contains(className))
108 ) || SPECIAL_ANNOTATIONS.contains(className) || className.getInternalName().startsWith("jet/runtime/typeinfo/");
109 }
110
111 private JvmAnnotationNames() {
112 }
113 }