'Add annotations to classpath' quickfix supported when IDEA is running from sources
[idea/community.git] / java / java-impl / src / com / intellij / codeInsight / daemon / impl / quickfix / JetBrainsAnnotationsExternalLibraryResolver.java
1 /*
2  * Copyright 2000-2015 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.codeInsight.daemon.impl.quickfix;
17
18 import com.intellij.codeInsight.AnnotationUtil;
19 import com.intellij.codeInsight.daemon.quickFix.ExternalLibraryResolver;
20 import com.intellij.openapi.application.PathManager;
21 import com.intellij.openapi.module.EffectiveLanguageLevelUtil;
22 import com.intellij.openapi.module.Module;
23 import com.intellij.openapi.roots.ExternalLibraryDescriptor;
24 import com.intellij.openapi.util.io.FileUtil;
25 import com.intellij.pom.java.LanguageLevel;
26 import com.intellij.util.ThreeState;
27 import org.intellij.lang.annotations.Flow;
28 import org.jetbrains.annotations.NotNull;
29 import org.jetbrains.annotations.Nullable;
30
31 import java.io.File;
32 import java.util.Arrays;
33 import java.util.Collections;
34 import java.util.List;
35
36 /**
37  * @author nik
38  */
39 public class JetBrainsAnnotationsExternalLibraryResolver extends ExternalLibraryResolver {
40   private static final ExternalLibraryDescriptor JAVA5 = new JetBrainsAnnotationsLibraryDescriptor() {
41     @NotNull
42     @Override
43     public List<String> getLibraryClassesRoots() {
44       File annotationsJar = new File(PathManager.getLibPath(), "annotations.jar");
45       if (annotationsJar.exists()) {
46         return Collections.singletonList(FileUtil.toSystemIndependentName(annotationsJar.getAbsolutePath()));
47       }
48       return getPathsToAnnotationsDirectoriesInDevelopmentMode("annotations");
49     }
50   };
51
52   private static final ExternalLibraryDescriptor JAVA8 = new JetBrainsAnnotationsLibraryDescriptor() {
53     @NotNull
54     @Override
55     public List<String> getLibraryClassesRoots() {
56       File annotationsJar = new File(PathManager.getHomePath(), "redist/annotations-java8.jar");
57       if (annotationsJar.exists()) {
58         return Collections.singletonList(FileUtil.toSystemIndependentName(annotationsJar.getAbsolutePath()));
59       }
60       return getPathsToAnnotationsDirectoriesInDevelopmentMode("annotations-java8");
61     }
62   };
63
64   @NotNull
65   private static List<String> getPathsToAnnotationsDirectoriesInDevelopmentMode(final String moduleName) {
66     final String annotationsRoot = PathManager.getJarPathForClass(Flow.class);
67     if (annotationsRoot == null) return Collections.emptyList();
68     return Arrays.asList(annotationsRoot, FileUtil.toSystemIndependentName(new File(new File(annotationsRoot).getParentFile(),
69                                                                                     moduleName).getAbsolutePath()));
70   }
71
72   @Nullable
73   @Override
74   public ExternalClassResolveResult resolveClass(@NotNull String shortClassName, @NotNull ThreeState isAnnotation, @NotNull Module contextModule) {
75     if (AnnotationUtil.isJetbrainsAnnotation(shortClassName)) {
76       ExternalLibraryDescriptor libraryDescriptor = getAnnotationsLibraryDescriptor(contextModule);
77       return new ExternalClassResolveResult("org.jetbrains.annotations." + shortClassName, libraryDescriptor);
78     }
79     return null;
80   }
81
82   @NotNull
83   public static ExternalLibraryDescriptor getAnnotationsLibraryDescriptor(@NotNull Module contextModule) {
84     boolean java8 = EffectiveLanguageLevelUtil.getEffectiveLanguageLevel(contextModule).isAtLeast(LanguageLevel.JDK_1_8);
85     return java8 ? JAVA8 : JAVA5;
86   }
87
88   private static abstract class JetBrainsAnnotationsLibraryDescriptor extends ExternalLibraryDescriptor {
89     public JetBrainsAnnotationsLibraryDescriptor() {
90       super("com.intellij", "annotations", null);
91     }
92   }
93 }