Merge remote-tracking branch 'origin/master' into develar/is
[idea/community.git] / platform / analysis-impl / src / com / intellij / codeInspection / ex / LocalInspectionToolWrapper.java
1 /*
2  * Copyright 2000-2016 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
17 package com.intellij.codeInspection.ex;
18
19 import com.intellij.codeInspection.GlobalInspectionContext;
20 import com.intellij.codeInspection.InspectionProfile;
21 import com.intellij.codeInspection.LocalInspectionEP;
22 import com.intellij.codeInspection.LocalInspectionTool;
23 import com.intellij.openapi.project.Project;
24 import com.intellij.openapi.util.NotNullLazyValue;
25 import com.intellij.profile.codeInspection.InspectionProjectProfileManager;
26 import com.intellij.psi.PsiElement;
27 import gnu.trove.THashMap;
28 import org.jetbrains.annotations.NotNull;
29 import org.jetbrains.annotations.Nullable;
30 import org.jetbrains.annotations.TestOnly;
31
32 import java.util.Map;
33
34 /**
35  * @author max
36  */
37 public class LocalInspectionToolWrapper extends InspectionToolWrapper<LocalInspectionTool, LocalInspectionEP> {
38   /** This should be used in tests primarily */
39   @TestOnly
40   public LocalInspectionToolWrapper(@NotNull LocalInspectionTool tool) {
41     super(tool, ourEPMap.getValue().get(tool.getShortName()));
42   }
43
44   public LocalInspectionToolWrapper(@NotNull LocalInspectionEP ep) {
45     super(ep);
46   }
47
48   private LocalInspectionToolWrapper(@NotNull LocalInspectionToolWrapper other) {
49     super(other);
50   }
51
52   @NotNull
53   @Override
54   public LocalInspectionToolWrapper createCopy() {
55     return new LocalInspectionToolWrapper(this);
56   }
57
58   @Override
59   @NotNull
60   public JobDescriptor[] getJobDescriptors(@NotNull GlobalInspectionContext context) {
61     return context.getStdJobDescriptors().LOCAL_ANALYSIS_ARRAY;
62   }
63
64   public boolean isUnfair() {
65     return myEP == null ? getTool() instanceof UnfairLocalInspectionTool : myEP.unfair;
66   }
67
68   @Override
69   public String getID() {
70     return myEP == null ? getTool().getID() : myEP.id == null ? myEP.getShortName() : myEP.id;
71   }
72
73   @Nullable
74   public String getAlternativeID() {
75     return myEP == null ? getTool().getAlternativeID() : myEP.alternativeId;
76   }
77
78   public boolean runForWholeFile() {
79     return myEP == null ? getTool().runForWholeFile() : myEP.runForWholeFile;
80   }
81
82   private static final NotNullLazyValue<Map<String, LocalInspectionEP>> ourEPMap = new NotNullLazyValue<Map<String, LocalInspectionEP>>() {
83     @NotNull
84     @Override
85     protected Map<String, LocalInspectionEP> compute() {
86       Map<String, LocalInspectionEP> map = new THashMap<>();
87       for (LocalInspectionEP ep : LocalInspectionEP.LOCAL_INSPECTION.getExtensions()) {
88         map.put(ep.getShortName(), ep);
89       }
90       return map;
91     }
92   };
93
94   @Nullable
95   public static InspectionToolWrapper findTool2RunInBatch(@NotNull Project project, @Nullable PsiElement element, @NotNull String name) {
96     final InspectionProfile inspectionProfile = InspectionProjectProfileManager.getInstance(project).getCurrentProfile();
97     final InspectionToolWrapper toolWrapper = element == null
98                                            ? inspectionProfile.getInspectionTool(name, project)
99                                            : inspectionProfile.getInspectionTool(name, element);
100     return findTool2RunInBatch(project, element, inspectionProfile, toolWrapper);
101   }
102
103   @Nullable
104   public static InspectionToolWrapper findTool2RunInBatch(@NotNull Project project,
105                                                           @Nullable PsiElement element,
106                                                           @NotNull InspectionProfile inspectionProfile,
107                                                           @Nullable InspectionToolWrapper toolWrapper) {
108     if (toolWrapper instanceof LocalInspectionToolWrapper && ((LocalInspectionToolWrapper)toolWrapper).isUnfair()) {
109       LocalInspectionTool inspectionTool = ((LocalInspectionToolWrapper)toolWrapper).getTool();
110       if (inspectionTool instanceof PairedUnfairLocalInspectionTool) {
111         String oppositeShortName = ((PairedUnfairLocalInspectionTool)inspectionTool).getInspectionForBatchShortName();
112         return element == null ? inspectionProfile.getInspectionTool(oppositeShortName, project)
113                                : inspectionProfile.getInspectionTool(oppositeShortName, element);
114       }
115       return null;
116     }
117     return toolWrapper;
118   }
119 }