From c75c96aac133ff778a42ff41e05e1e6a17f1361d Mon Sep 17 00:00:00 2001
From: Alexander Zolotov <alexander.zolotov@jetbrains.com>
Date: Fri, 21 Aug 2015 21:27:40 +0300
Subject: [PATCH] Introduce extendable comment reference provider type

---
 ...utor.java => CommentsReferenceContributor.java} | 14 ++++++++++++--
 .../src/META-INF/LangExtensions.xml                |  4 +++-
 .../impl/providers/JavaReferenceContributor.java   |  5 +++--
 .../intellij/xml/util/XmlReferenceContributor.java |  2 +-
 4 files changed, 19 insertions(+), 6 deletions(-)
 rename platform/lang-impl/src/com/intellij/psi/impl/source/resolve/reference/{ArbitraryPlaceUrlReferenceContributor.java => CommentsReferenceContributor.java} (59%)

diff --git a/platform/lang-impl/src/com/intellij/psi/impl/source/resolve/reference/ArbitraryPlaceUrlReferenceContributor.java b/platform/lang-impl/src/com/intellij/psi/impl/source/resolve/reference/CommentsReferenceContributor.java
similarity index 59%
rename from platform/lang-impl/src/com/intellij/psi/impl/source/resolve/reference/ArbitraryPlaceUrlReferenceContributor.java
rename to platform/lang-impl/src/com/intellij/psi/impl/source/resolve/reference/CommentsReferenceContributor.java
index cf036f80d0da..06c3a22d3e7d 100644
--- a/platform/lang-impl/src/com/intellij/psi/impl/source/resolve/reference/ArbitraryPlaceUrlReferenceContributor.java
+++ b/platform/lang-impl/src/com/intellij/psi/impl/source/resolve/reference/CommentsReferenceContributor.java
@@ -19,11 +19,21 @@ import com.intellij.patterns.PlatformPatterns;
 import com.intellij.psi.PsiComment;
 import com.intellij.psi.PsiReferenceContributor;
 import com.intellij.psi.PsiReferenceRegistrar;
+import com.intellij.psi.ReferenceProviderType;
 import org.jetbrains.annotations.NotNull;
 
-public class ArbitraryPlaceUrlReferenceContributor extends PsiReferenceContributor {
+public class CommentsReferenceContributor extends PsiReferenceContributor {
+  /**
+   * Use this provider type if your element is not PsiComment but you want to fill it 
+   * with the same references as PsiCommit (e.g. it's used for PsiDocToken).
+   * 
+   * Also you can register your own reference provider as 'comment reference provider' and it will be
+   * applied to all PsiComment and other elements that uses this provider type for retrieving references.
+   */
+  public static final ReferenceProviderType COMMENTS_REFERENCE_PROVIDER_TYPE = new ReferenceProviderType("commentsReferenceProvider");
+  
   @Override
   public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar) {
-    registrar.registerReferenceProvider(PlatformPatterns.psiElement(PsiComment.class), ArbitraryPlaceUrlReferenceProvider.INSTANCE);
+    registrar.registerReferenceProvider(PlatformPatterns.psiElement(PsiComment.class), COMMENTS_REFERENCE_PROVIDER_TYPE.getProvider());
   }
 }
diff --git a/platform/platform-resources/src/META-INF/LangExtensions.xml b/platform/platform-resources/src/META-INF/LangExtensions.xml
index a96bbb730bdb..d882f9231da4 100644
--- a/platform/platform-resources/src/META-INF/LangExtensions.xml
+++ b/platform/platform-resources/src/META-INF/LangExtensions.xml
@@ -767,7 +767,9 @@
     <psi.fileReferenceHelper implementation="com.intellij.psi.impl.source.resolve.reference.impl.providers.JarFileReferenceHelper"/>
     <psi.fileReferenceHelper implementation="com.intellij.psi.impl.source.resolve.reference.impl.providers.HttpFileReferenceHelper"/>
     <psi.fileReferenceHelper implementation="com.intellij.psi.impl.source.resolve.reference.impl.providers.NullFileReferenceHelper" order="last"/>
-    <psi.referenceContributor implementation="com.intellij.psi.impl.source.resolve.reference.ArbitraryPlaceUrlReferenceContributor"/>
+    <psi.referenceContributor implementation="com.intellij.psi.impl.source.resolve.reference.CommentsReferenceContributor"/>
+    <referenceProviderType key="commentsReferenceProvider"
+                           implementationClass="com.intellij.psi.impl.source.resolve.reference.ArbitraryPlaceUrlReferenceProvider"/>
 
     <projectConfigurable groupId="editor"
                          groupWeight="140"
diff --git a/plugins/java-i18n/src/com/intellij/psi/impl/source/resolve/reference/impl/providers/JavaReferenceContributor.java b/plugins/java-i18n/src/com/intellij/psi/impl/source/resolve/reference/impl/providers/JavaReferenceContributor.java
index 1d354866b2fd..bff0504509e6 100644
--- a/plugins/java-i18n/src/com/intellij/psi/impl/source/resolve/reference/impl/providers/JavaReferenceContributor.java
+++ b/plugins/java-i18n/src/com/intellij/psi/impl/source/resolve/reference/impl/providers/JavaReferenceContributor.java
@@ -21,7 +21,7 @@ import com.intellij.patterns.PlatformPatterns;
 import com.intellij.psi.*;
 import com.intellij.psi.filters.ElementFilter;
 import com.intellij.psi.filters.position.FilterPattern;
-import com.intellij.psi.impl.source.resolve.reference.ArbitraryPlaceUrlReferenceProvider;
+import com.intellij.psi.impl.source.resolve.reference.CommentsReferenceContributor;
 import com.intellij.psi.javadoc.PsiDocToken;
 import org.jetbrains.annotations.NotNull;
 
@@ -54,6 +54,7 @@ public class JavaReferenceContributor extends PsiReferenceContributor{
         return true;
       }
     })), filePathReferenceProvider);
-    registrar.registerReferenceProvider(PlatformPatterns.psiElement(PsiDocToken.class), ArbitraryPlaceUrlReferenceProvider.INSTANCE);
+    registrar.registerReferenceProvider(PlatformPatterns.psiElement(PsiDocToken.class),
+                                        CommentsReferenceContributor.COMMENTS_REFERENCE_PROVIDER_TYPE.getProvider());
   }
 }
diff --git a/xml/impl/src/com/intellij/xml/util/XmlReferenceContributor.java b/xml/impl/src/com/intellij/xml/util/XmlReferenceContributor.java
index 4e5a2391ab5d..387906711249 100644
--- a/xml/impl/src/com/intellij/xml/util/XmlReferenceContributor.java
+++ b/xml/impl/src/com/intellij/xml/util/XmlReferenceContributor.java
@@ -53,7 +53,7 @@ public class XmlReferenceContributor extends PsiReferenceContributor {
     registrar.registerReferenceProvider(PlatformPatterns.psiElement(XmlAttlistDecl.class), dtdReferencesProvider);
     registrar.registerReferenceProvider(PlatformPatterns.psiElement(XmlElementContentSpec.class), dtdReferencesProvider);
     registrar.registerReferenceProvider(PlatformPatterns.psiElement(XmlToken.class), dtdReferencesProvider);
-    registrar.registerReferenceProvider(xmlAttributeValue(), ArbitraryPlaceUrlReferenceProvider.INSTANCE, PsiReferenceRegistrar.LOWER_PRIORITY);
+    registrar.registerReferenceProvider(xmlAttributeValue(), new ArbitraryPlaceUrlReferenceProvider(), PsiReferenceRegistrar.LOWER_PRIORITY);
 
 
     URIReferenceProvider uriProvider = new URIReferenceProvider();