java/java-impl/src/com/intellij/codeInspection/concurrencyAnnotations/StaticGuardedByInstanceInspection.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.codeInspection.concurrencyAnnotations;
  17
  18 import com.intellij.codeInsight.daemon.GroupNames;
  19 import com.intellij.codeInspection.BaseJavaLocalInspectionTool;
  20 import com.intellij.codeInspection.ProblemsHolder;
  21 import com.intellij.psi.*;
  22 import com.intellij.psi.javadoc.PsiDocTag;
  23 import com.intellij.psi.util.PsiTreeUtil;
  24 import org.jetbrains.annotations.Nls;
  25 import org.jetbrains.annotations.NotNull;
  26
  27 public class StaticGuardedByInstanceInspection extends BaseJavaLocalInspectionTool {
  28
  29   @NotNull
  30   public String getGroupDisplayName() {
  31     return GroupNames.CONCURRENCY_ANNOTATION_ISSUES;
  32   }
  33
  34   @Nls
  35   @NotNull
  36   public String getDisplayName() {
  37     return "Static member guarded by instance field or this";
  38   }
  39
  40   @NotNull
  41   public String getShortName() {
  42     return "StaticGuardedByInstance";
  43   }
  44
  45   @NotNull
  46   public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
  47     return new Visitor(holder);
  48   }
  49
  50   private static class Visitor extends JavaElementVisitor {
  51     private final ProblemsHolder myHolder;
  52
  53     public Visitor(ProblemsHolder holder) {
  54       myHolder = holder;
  55     }
  56
  57     public void visitAnnotation(PsiAnnotation annotation) {
  58       super.visitAnnotation(annotation);
  59       if (!JCiPUtil.isGuardedByAnnotation(annotation)) {
  60         return;
  61       }
  62       final PsiMember member = PsiTreeUtil.getParentOfType(annotation, PsiMember.class);
  63       if (member == null) {
  64         return;
  65       }
  66       if (!member.hasModifierProperty(PsiModifier.STATIC)) {
  67         return;
  68       }
  69       final String guardValue = JCiPUtil.getGuardValue(annotation);
  70       if (guardValue == null) {
  71         return;
  72       }
  73
  74       final PsiAnnotationMemberValue guardRef = annotation.findAttributeValue("value");
  75       if (guardRef == null) {
  76         return;
  77       }
  78       if ("this".equals(guardValue)) {
  79         registerError(guardRef);
  80       }
  81       final PsiClass containingClass = PsiTreeUtil.getParentOfType(annotation, PsiClass.class);
  82       if (containingClass == null) {
  83         return;
  84       }
  85       final PsiField guardField = containingClass.findFieldByName(guardValue, true);
  86       if (guardField == null) {
  87         return;
  88       }
  89       if (guardField.hasModifierProperty(PsiModifier.STATIC)) {
  90         return;
  91       }
  92       registerError(guardRef);
  93     }
  94
  95     public void visitDocTag(PsiDocTag psiDocTag) {
  96       super.visitDocTag(psiDocTag);
  97       if (!JCiPUtil.isGuardedByTag(psiDocTag)) {
  98         return;
  99       }
 100       final PsiMember member = PsiTreeUtil.getParentOfType(psiDocTag, PsiMember.class);
 101       if (member == null) {
 102         return;
 103       }
 104       if (!member.hasModifierProperty(PsiModifier.STATIC)) {
 105         return;
 106       }
 107       final String guardValue = JCiPUtil.getGuardValue(psiDocTag);
 108
 109       if ("this".equals(guardValue)) {
 110         registerError(psiDocTag);
 111       }
 112       final PsiClass containingClass = PsiTreeUtil.getParentOfType(psiDocTag, PsiClass.class);
 113       if (containingClass == null) {
 114         return;
 115       }
 116       final PsiField guardField = containingClass.findFieldByName(guardValue, true);
 117       if (guardField == null) {
 118         return;
 119       }
 120       if (guardField.hasModifierProperty(PsiModifier.STATIC)) {
 121         return;
 122       }
 123       myHolder.registerProblem(psiDocTag, "Static member guarded by instance \"" + guardValue + "\" #loc");
 124     }
 125
 126     private void registerError(PsiElement element) {
 127       myHolder.registerProblem(element, "Static member guarded by instance #ref #loc");
 128     }
 129
 130     public void visitReferenceExpression(PsiReferenceExpression expression) {
 131     }
 132   }
 133 }