xml/impl/src/com/intellij/xml/util/XmlDuplicatedIdInspection.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.xml.util;
  17
  18 import com.intellij.codeHighlighting.HighlightDisplayLevel;
  19 import com.intellij.codeInsight.daemon.XmlErrorMessages;
  20 import com.intellij.codeInsight.daemon.impl.analysis.XmlHighlightVisitor;
  21 import com.intellij.codeInspection.LocalInspectionTool;
  22 import com.intellij.codeInspection.ProblemHighlightType;
  23 import com.intellij.codeInspection.ProblemsHolder;
  24 import com.intellij.openapi.extensions.Extensions;
  25 import com.intellij.openapi.util.text.StringUtil;
  26 import com.intellij.psi.*;
  27 import com.intellij.psi.html.HtmlTag;
  28 import com.intellij.psi.xml.XmlAttribute;
  29 import com.intellij.psi.xml.XmlAttributeValue;
  30 import com.intellij.psi.xml.XmlFile;
  31 import com.intellij.psi.xml.XmlTag;
  32 import com.intellij.xml.XmlBundle;
  33 import org.jetbrains.annotations.NonNls;
  34 import org.jetbrains.annotations.NotNull;
  35
  36 /**
  37  * @author Dmitry Avdeev
  38  */
  39 public class XmlDuplicatedIdInspection extends LocalInspectionTool {
  40
  41   @NotNull
  42   @Override
  43   public PsiElementVisitor buildVisitor(@NotNull final ProblemsHolder holder, final boolean isOnTheFly) {
  44     return new XmlElementVisitor() {
  45       @Override
  46       public void visitXmlAttributeValue(final XmlAttributeValue value) {
  47         if (value.getTextRange().isEmpty()) {
  48           return;
  49         }
  50         final PsiFile file = value.getContainingFile();
  51         if (file instanceof XmlFile) {
  52           final XmlRefCountHolder refHolder = XmlRefCountHolder.getInstance((XmlFile)file);
  53           if (refHolder == null) return;
  54
  55           final PsiElement parent = value.getParent();
  56           if (!(parent instanceof XmlAttribute)) return;
  57           final XmlTag tag = ((XmlAttribute)parent).getParent();
  58           if (tag == null) return;
  59
  60           if (refHolder.isValidatable(tag.getParent()) && refHolder.isDuplicateIdAttributeValue(value)) {
  61             holder.registerProblem(value, XmlErrorMessages.message("duplicate.id.reference"), ProblemHighlightType.LIKE_UNKNOWN_SYMBOL);
  62           }
  63
  64           String idRef = XmlHighlightVisitor.getUnquotedValue(value, tag);
  65
  66           if (tag instanceof HtmlTag) {
  67             idRef = idRef.toLowerCase();
  68           }
  69
  70           if (XmlUtil.isSimpleXmlAttributeValue(idRef, value) && refHolder.isIdReferenceValue(value)) {
  71             boolean hasIdDeclaration = refHolder.hasIdDeclaration(idRef);
  72             if (!hasIdDeclaration && tag instanceof HtmlTag) {
  73               hasIdDeclaration = refHolder.hasIdDeclaration(StringUtil.stripQuotesAroundValue(value.getText()));
  74             }
  75
  76             if (!hasIdDeclaration) {
  77               for(XmlIdContributor contributor: Extensions.getExtensions(XmlIdContributor.EP_NAME)) {
  78                 if (contributor.suppressExistingIdValidation((XmlFile)file)) {
  79                   return;
  80                 }
  81               }
  82
  83               final FileViewProvider viewProvider = tag.getContainingFile().getViewProvider();
  84               if (viewProvider instanceof MultiplePsiFilesPerDocumentFileViewProvider) {
  85                 holder.registerProblem(value, XmlErrorMessages.message("invalid.id.reference"), ProblemHighlightType.LIKE_UNKNOWN_SYMBOL,
  86                                        new XmlDeclareIdInCommentAction(idRef));
  87
  88               }
  89               else {
  90                 holder.registerProblem(value, XmlErrorMessages.message("invalid.id.reference"), ProblemHighlightType.LIKE_UNKNOWN_SYMBOL);
  91               }
  92             }
  93           }
  94         }
  95       }
  96     };
  97   }
  98
  99   public boolean runForWholeFile() {
 100     return false;
 101   }
 102
 103   @NotNull
 104   public HighlightDisplayLevel getDefaultLevel() {
 105     return HighlightDisplayLevel.ERROR;
 106   }
 107
 108   public boolean isEnabledByDefault() {
 109     return true;
 110   }
 111
 112   @NotNull
 113   public String getGroupDisplayName() {
 114     return XmlBundle.message("xml.inspections.group.name");
 115   }
 116
 117   @NotNull
 118   public String getDisplayName() {
 119     return XmlBundle.message("xml.inspections.duplicated.id");
 120   }
 121
 122   @NotNull
 123   @NonNls
 124   public String getShortName() {
 125     return "XmlDuplicatedId";
 126   }
 127 }