do not search for prefixed properties without JSPs
[idea/community.git] / plugins / properties / src / com / intellij / lang / properties / UnusedPropertyInspection.java
1 /*
2  * Copyright 2000-2009 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.lang.properties;
17
18 import com.intellij.codeInspection.LocalInspectionToolSession;
19 import com.intellij.codeInspection.ProblemHighlightType;
20 import com.intellij.codeInspection.ProblemsHolder;
21 import com.intellij.lang.ASTNode;
22 import com.intellij.lang.properties.findUsages.PropertySearcher;
23 import com.intellij.lang.properties.psi.Property;
24 import com.intellij.openapi.extensions.Extensions;
25 import com.intellij.openapi.module.Module;
26 import com.intellij.openapi.module.ModuleUtil;
27 import com.intellij.openapi.progress.ProgressIndicator;
28 import com.intellij.openapi.progress.ProgressManager;
29 import com.intellij.psi.PsiElement;
30 import com.intellij.psi.PsiElementVisitor;
31 import com.intellij.psi.PsiFile;
32 import com.intellij.psi.search.GlobalSearchScope;
33 import com.intellij.psi.search.PsiSearchHelper;
34 import com.intellij.psi.search.searches.ReferencesSearch;
35 import com.intellij.util.containers.ContainerUtil;
36 import com.intellij.util.containers.FilteringIterator;
37 import org.jetbrains.annotations.NotNull;
38
39 /**
40  * @author cdr
41  */
42 public class UnusedPropertyInspection extends PropertySuppressableInspectionBase {
43   @NotNull
44   public String getDisplayName() {
45     return PropertiesBundle.message("unused.property.inspection.display.name");
46   }
47
48   @NotNull
49   public String getShortName() {
50     return "UnusedProperty";
51   }
52
53   @NotNull
54   @Override
55   public PsiElementVisitor buildVisitor(@NotNull final ProblemsHolder holder,
56                                         final boolean isOnTheFly,
57                                         @NotNull final LocalInspectionToolSession session) {
58     final PsiFile file = session.getFile();
59     Module module = ModuleUtil.findModuleForPsiElement(file);
60     if (module == null) return super.buildVisitor(holder, isOnTheFly, session);
61     Object[] extensions = Extensions.getExtensions("com.intellij.referencesSearch");
62     final PropertySearcher searcher =
63       (PropertySearcher)ContainerUtil.find(extensions, new FilteringIterator.InstanceOf<PropertySearcher>(PropertySearcher.class));
64     final GlobalSearchScope searchScope = GlobalSearchScope.moduleWithDependentsScope(module);
65     final PsiSearchHelper searchHelper = PsiSearchHelper.SERVICE.getInstance(file.getProject());
66     return new PsiElementVisitor() {
67       @Override
68       public void visitElement(PsiElement element) {
69         if (!(element instanceof Property)) return;
70         Property property = (Property)element;
71
72         final ProgressIndicator original = ProgressManager.getInstance().getProgressIndicator();
73         if (original != null) {
74           if (original.isCanceled()) return;
75           original.setText(PropertiesBundle.message("searching.for.property.key.progress.text", property.getUnescapedKey()));
76         }
77
78         String name = property.getName();
79         if (name == null) return;
80         if (searcher != null) {
81           name = searcher.getKeyToSearch(name);
82           if (name == null) return;
83         }
84
85         PsiSearchHelper.SearchCostResult cheapEnough = searchHelper.isCheapEnoughToSearch(name, searchScope, file, original);
86         if (cheapEnough == PsiSearchHelper.SearchCostResult.TOO_MANY_OCCURRENCES) return;
87
88         if (cheapEnough != PsiSearchHelper.SearchCostResult.ZERO_OCCURRENCES &&
89             ReferencesSearch.search(property, searchScope, false).findFirst() != null) {
90           return;
91         }
92
93         final ASTNode propertyNode = property.getNode();
94         assert propertyNode != null;
95
96         ASTNode[] nodes = propertyNode.getChildren(null);
97         PsiElement key = nodes.length == 0 ? property : nodes[0].getPsi();
98         String description = PropertiesBundle.message("unused.property.problem.descriptor.name");
99
100         holder.registerProblem(key, description, ProblemHighlightType.LIKE_UNUSED_SYMBOL,RemovePropertyLocalFix.INSTANCE);
101       }
102     };
103   }
104 }