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