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 org.jetbrains.annotations.NotNull;
020 import org.jetbrains.kotlin.name.ClassId;
021 import org.jetbrains.kotlin.name.FqName;
022 import org.jetbrains.kotlin.name.Name;
023 import org.jetbrains.kotlin.resolve.jvm.JvmClassName;
024
025 import java.util.Arrays;
026 import java.util.HashSet;
027 import java.util.Set;
028
029 public final class JvmAnnotationNames {
030 public static final FqName METADATA = new FqName("kotlin.Metadata");
031
032 public static final FqName KOTLIN_CLASS = new FqName("kotlin.jvm.internal.KotlinClass");
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
039 public static final String VERSION_FIELD_NAME = "version";
040 public static final String METADATA_VERSION_FIELD_NAME = "mv";
041 public static final String BYTECODE_VERSION_FIELD_NAME = "bv";
042 public static final String FILE_PART_CLASS_NAMES_FIELD_NAME = "filePartClassNames";
043 public static final String MULTIFILE_CLASS_NAME_FIELD_NAME = "multifileClassName";
044 public static final String KIND_FIELD_NAME = "k";
045 public static final String METADATA_DATA_FIELD_NAME = "d1";
046 public static final String METADATA_STRINGS_FIELD_NAME = "d2";
047 public static final String METADATA_MULTIFILE_CLASS_NAME_FIELD_NAME = "xs";
048 public static final String DATA_FIELD_NAME = "data";
049 public static final String STRINGS_FIELD_NAME = "strings";
050 public static final Name DEFAULT_ANNOTATION_MEMBER_NAME = Name.identifier("value");
051 public static final Name DEPRECATED_ANNOTATION_MESSAGE = Name.identifier("message");
052 public static final Name TARGET_ANNOTATION_MEMBER_NAME = Name.identifier("allowedTargets");
053
054 public static final FqName TARGET_ANNOTATION = new FqName("java.lang.annotation.Target");
055 public static final FqName RETENTION_ANNOTATION = new FqName("java.lang.annotation.Retention");
056 public static final FqName DOCUMENTED_ANNOTATION = new FqName("java.lang.annotation.Documented");
057
058 public static final FqName JETBRAINS_NOT_NULL_ANNOTATION = new FqName("org.jetbrains.annotations.NotNull");
059 public static final FqName JETBRAINS_NULLABLE_ANNOTATION = new FqName("org.jetbrains.annotations.Nullable");
060 public static final FqName JETBRAINS_MUTABLE_ANNOTATION = new FqName("org.jetbrains.annotations.Mutable");
061 public static final FqName JETBRAINS_READONLY_ANNOTATION = new FqName("org.jetbrains.annotations.ReadOnly");
062
063 public static final FqName PURELY_IMPLEMENTS_ANNOTATION = new FqName("kotlin.jvm.PurelyImplements");
064
065 // Just for internal use: there is no such real classes in bytecode
066 public static final FqName ENHANCED_NULLABILITY_ANNOTATION = new FqName("kotlin.jvm.internal.EnhancedNullability");
067 public static final FqName ENHANCED_MUTABILITY_ANNOTATION = new FqName("kotlin.jvm.internal.EnhancedMutability");
068
069 private static final Set<JvmClassName> SPECIAL_ANNOTATIONS = new HashSet<JvmClassName>();
070 private static final Set<JvmClassName> NULLABILITY_ANNOTATIONS = new HashSet<JvmClassName>();
071 private static final Set<JvmClassName> SPECIAL_META_ANNOTATIONS = new HashSet<JvmClassName>();
072 static {
073 for (FqName fqName : Arrays.asList(METADATA, KOTLIN_CLASS, KOTLIN_SYNTHETIC_CLASS)) {
074 SPECIAL_ANNOTATIONS.add(JvmClassName.byFqNameWithoutInnerClasses(fqName));
075 }
076
077 for (FqName fqName : Arrays.asList(JETBRAINS_NOT_NULL_ANNOTATION, JETBRAINS_NULLABLE_ANNOTATION)) {
078 NULLABILITY_ANNOTATIONS.add(JvmClassName.byFqNameWithoutInnerClasses(fqName));
079 }
080
081 for (FqName fqName : Arrays.asList(TARGET_ANNOTATION, RETENTION_ANNOTATION, DOCUMENTED_ANNOTATION)) {
082 SPECIAL_META_ANNOTATIONS.add(JvmClassName.byFqNameWithoutInnerClasses(fqName));
083 }
084 }
085
086 public static boolean isSpecialAnnotation(@NotNull ClassId classId, boolean javaSpecificAnnotationsAreSpecial) {
087 JvmClassName className = JvmClassName.byClassId(classId);
088 return (javaSpecificAnnotationsAreSpecial
089 && (NULLABILITY_ANNOTATIONS.contains(className) || SPECIAL_META_ANNOTATIONS.contains(className))
090 ) || SPECIAL_ANNOTATIONS.contains(className);
091 }
092
093 private JvmAnnotationNames() {
094 }
095 }