cleanup
[idea/community.git] / xml / impl / src / com / intellij / xml / util / AnchorReference.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.codeInsight.daemon.EmptyResolveMessageProvider;
19 import com.intellij.codeInsight.lookup.LookupElement;
20 import com.intellij.codeInsight.lookup.LookupElementBuilder;
21 import com.intellij.openapi.util.Key;
22 import com.intellij.openapi.util.TextRange;
23 import com.intellij.psi.ElementManipulators;
24 import com.intellij.psi.PsiElement;
25 import com.intellij.psi.PsiFile;
26 import com.intellij.psi.PsiReference;
27 import com.intellij.psi.impl.source.resolve.reference.impl.providers.FileReference;
28 import com.intellij.psi.search.PsiElementProcessor;
29 import com.intellij.psi.util.CachedValue;
30 import com.intellij.psi.util.CachedValueProvider;
31 import com.intellij.psi.util.CachedValuesManager;
32 import com.intellij.psi.xml.*;
33 import com.intellij.util.ArrayUtil;
34 import com.intellij.util.IncorrectOperationException;
35 import com.intellij.util.containers.HashMap;
36 import com.intellij.xml.XmlBundle;
37 import com.intellij.xml.XmlExtension;
38 import org.jetbrains.annotations.NonNls;
39 import org.jetbrains.annotations.NotNull;
40 import org.jetbrains.annotations.Nullable;
41
42 import java.util.Map;
43
44 /**
45  * @author Maxim.Mossienko
46  */
47 class AnchorReference implements PsiReference, EmptyResolveMessageProvider {
48   private final String myAnchor;
49   private final PsiReference myFileReference;
50   private final PsiElement myElement;
51   private final int myOffset;
52   private final boolean mySoft;
53   @NonNls
54   private static final String ANCHOR_ELEMENT_NAME = "a";
55   private static final String MAP_ELEMENT_NAME = "map";
56   private static final Key<CachedValue<Map<String,XmlTag>>> ourCachedIdsKey = Key.create("cached.ids");
57
58   AnchorReference(final String anchor, @Nullable final FileReference psiReference, final PsiElement element, final int offset,
59                   final boolean soft) {
60
61     myAnchor = anchor;
62     myFileReference = psiReference;
63     myElement = element;
64     myOffset = offset;
65     mySoft = soft;
66   }
67
68   public PsiElement getElement() {
69     return myElement;
70   }
71
72   public TextRange getRangeInElement() {
73     return new TextRange(myOffset,myOffset+myAnchor.length());
74   }
75
76   public PsiElement resolve() {
77     if (myAnchor.length() == 0) {
78       return myElement;
79     }
80     Map<String,XmlTag> map = getIdMap();
81     final XmlTag tag = map != null ? map.get(myAnchor):null;
82     if (tag != null) {
83       XmlAttribute attribute = tag.getAttribute("id");
84       if (attribute==null) attribute = tag.getAttribute("name");
85
86       if (attribute == null && MAP_ELEMENT_NAME.equalsIgnoreCase(tag.getName())) {
87         attribute = tag.getAttribute("usemap");
88       }
89
90       assert attribute != null;
91       return attribute.getValueElement();
92     }
93
94     return null;
95   }
96
97   private static boolean processXmlElements(XmlTag element, PsiElementProcessor<XmlTag> processor) {
98     if (!_processXmlElements(element,processor)) return false;
99
100     for(PsiElement next = element.getNextSibling(); next != null; next = next.getNextSibling()) {
101       if (next instanceof XmlTag) {
102         if (!_processXmlElements((XmlTag)next,processor)) return false;
103       }
104     }
105
106     return true;
107   }
108
109   static boolean _processXmlElements(XmlTag element, PsiElementProcessor<XmlTag> processor) {
110     if (!processor.execute(element)) return false;
111     final XmlTag[] subTags = element.getSubTags();
112
113     for (XmlTag subTag : subTags) {
114       if (!_processXmlElements(subTag, processor)) return false;
115     }
116
117     return true;
118   }
119
120   @Nullable
121   private Map<String,XmlTag> getIdMap() {
122     final XmlFile file = getFile();
123
124     if (file != null) {
125       CachedValue<Map<String, XmlTag>> value = file.getUserData(ourCachedIdsKey);
126       if (value == null) {
127         value = CachedValuesManager.getManager(file.getProject()).createCachedValue(new MapCachedValueProvider(file), false);
128         file.putUserData(ourCachedIdsKey, value);
129       }
130
131       return value.getValue();
132     }
133     return null;
134   }
135
136   @Nullable
137   private static String getAnchorValue(final XmlTag xmlTag) {
138     final String attributeValue = xmlTag.getAttributeValue("id");
139
140     if (attributeValue!=null) {
141       return attributeValue;
142     }
143
144     if (ANCHOR_ELEMENT_NAME.equalsIgnoreCase(xmlTag.getName())) {
145       final String attributeValue2 = xmlTag.getAttributeValue("name");
146       if (attributeValue2!=null) {
147         return attributeValue2;
148       }
149     }
150
151     if (MAP_ELEMENT_NAME.equalsIgnoreCase(xmlTag.getName())) {
152       final String map_anchor = xmlTag.getAttributeValue("name");
153       if (map_anchor != null) {
154         return map_anchor;
155       }
156     }
157
158     return null;
159   }
160
161   @NotNull
162   public String getCanonicalText() {
163     return myAnchor;
164   }
165
166   public PsiElement handleElementRename(String newElementName) throws IncorrectOperationException {
167     return ElementManipulators.getManipulator(myElement).handleContentChange(
168       myElement,
169       getRangeInElement(),
170       newElementName
171     );
172   }
173
174   @Nullable
175   public PsiElement bindToElement(@NotNull PsiElement element) throws IncorrectOperationException {
176     return null;
177   }
178
179   public boolean isReferenceTo(PsiElement element) {
180     if (!(element instanceof XmlAttributeValue)) return false;
181     return myElement.getManager().areElementsEquivalent(element,resolve());
182   }
183
184   @NotNull
185   public Object[] getVariants() {
186     final Map<String, XmlTag> idMap = getIdMap();
187     if (idMap == null) return ArrayUtil.EMPTY_OBJECT_ARRAY;
188
189     String[] variants = idMap.keySet().toArray(new String[idMap.size()]);
190     LookupElement[] elements = new LookupElement[variants.length];
191     for (int i = 0, variantsLength = variants.length; i < variantsLength; i++) {
192       elements[i] = LookupElementBuilder.create(variants[i]).setCaseSensitive(true);
193     }
194     return elements;
195   }
196
197   @Nullable
198   private XmlFile getFile() {
199     if (myFileReference != null) {
200       final PsiElement psiElement = myFileReference.resolve();
201       return psiElement instanceof XmlFile ? (XmlFile)psiElement:null;
202     }
203
204     final PsiFile containingFile = myElement.getContainingFile();
205     if (containingFile instanceof XmlFile) {
206       return (XmlFile)containingFile;
207     }
208     else {
209       final XmlExtension extension = XmlExtension.getExtensionByElement(myElement);
210       return extension == null ? null : extension.getContainingFile(myElement);
211     }
212   }
213
214   public boolean isSoft() {
215     return mySoft;
216   }
217
218   public String getUnresolvedMessagePattern() {
219     final XmlFile xmlFile = getFile();
220     return xmlFile == null ? 
221            XmlBundle.message("cannot.resolve.anchor", myAnchor) :
222            XmlBundle.message("cannot.resolve.anchor.in.file", myAnchor, xmlFile.getName());
223   }
224
225   // separate static class to avoid memory leak via this$0
226   private static class MapCachedValueProvider implements CachedValueProvider<Map<String, XmlTag>> {
227     private final XmlFile myFile;
228
229     public MapCachedValueProvider(XmlFile file) {
230       myFile = file;
231     }
232
233     public Result<Map<String, XmlTag>> compute() {
234       final Map<String,XmlTag> resultMap = new HashMap<String, XmlTag>();
235       XmlDocument document = HtmlUtil.getRealXmlDocument(myFile.getDocument());
236       final XmlTag rootTag = document != null ? document.getRootTag():null;
237
238       if (rootTag != null) {
239         processXmlElements(rootTag,
240           new PsiElementProcessor<XmlTag>() {
241             public boolean execute(@NotNull final XmlTag element) {
242               final String anchorValue = getAnchorValue(element);
243
244               if (anchorValue!=null) {
245                 resultMap.put(anchorValue, element);
246               }
247               return true;
248             }
249           }
250         );
251       }
252       return new Result<Map<String, XmlTag>>(resultMap, myFile);
253     }
254   }
255 }