dca886a3727a4f514a6e5eade613e3785b2a1eb3
[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.psi.Property;
23 import com.intellij.openapi.module.Module;
24 import com.intellij.openapi.module.ModuleUtil;
25 import com.intellij.openapi.progress.ProgressIndicator;
26 import com.intellij.openapi.progress.ProgressManager;
27 import com.intellij.psi.*;
28 import com.intellij.psi.search.GlobalSearchScope;
29 import com.intellij.psi.search.PsiSearchHelper;
30 import com.intellij.psi.search.searches.ReferencesSearch;
31 import org.jetbrains.annotations.NotNull;
32
33 /**
34  * @author cdr
35  */
36 public class UnusedPropertyInspection extends PropertySuppressableInspectionBase {
37   @NotNull
38   public String getDisplayName() {
39     return PropertiesBundle.message("unused.property.inspection.display.name");
40   }
41
42   @NotNull
43   public String getShortName() {
44     return "UnusedProperty";
45   }
46
47
48   @NotNull
49   @Override
50   public PsiElementVisitor buildVisitor(@NotNull final ProblemsHolder holder,
51                                         final boolean isOnTheFly,
52                                         @NotNull final LocalInspectionToolSession session) {
53     final PsiFile file = session.getFile();
54     Module module = ModuleUtil.findModuleForPsiElement(file);
55     if (module == null) return super.buildVisitor(holder, isOnTheFly, session);
56     final GlobalSearchScope searchScope = GlobalSearchScope.moduleWithDependentsScope(module);
57     final PsiSearchHelper searchHelper = PsiSearchHelper.SERVICE.getInstance(file.getProject());
58     return new PsiElementVisitor() {
59       @Override
60       public void visitElement(PsiElement element) {
61         if (!(element instanceof Property)) return;
62         Property property = (Property)element;
63
64         final ProgressIndicator original = ProgressManager.getInstance().getProgressIndicator();
65         if (original != null) {
66           if (original.isCanceled()) return;
67           original.setText(PropertiesBundle.message("searching.for.property.key.progress.text", property.getUnescapedKey()));
68         }
69
70         String name = property.getName();
71         if (name == null) return;
72         PsiSearchHelper.SearchCostResult cheapEnough = searchHelper.isCheapEnoughToSearch(name, searchScope, file, original);
73         if (cheapEnough == PsiSearchHelper.SearchCostResult.TOO_MANY_OCCURRENCES) return;
74
75         final PsiReference usage = cheapEnough == PsiSearchHelper.SearchCostResult.ZERO_OCCURRENCES ? null :
76                                    ReferencesSearch.search(property, searchScope, false).findFirst();
77         if (usage != null) return;
78         final ASTNode propertyNode = property.getNode();
79         assert propertyNode != null;
80
81         ASTNode[] nodes = propertyNode.getChildren(null);
82         PsiElement key = nodes.length == 0 ? property : nodes[0].getPsi();
83         String description = PropertiesBundle.message("unused.property.problem.descriptor.name");
84
85         holder.registerProblem(key, description, ProblemHighlightType.LIKE_UNUSED_SYMBOL,RemovePropertyLocalFix.INSTANCE);
86       }
87     };
88   }
89 }