add reference provider for twig block function Haehnchen#266

Author: Haehnchen

META-INF/plugin.xml

@@ -365,7 +365,7 @@
 
  <typedHandler implementation="fr.adrienbrault.idea.symfony2plugin.templating.WorkaroundTwigTypedHandler"/>
 
- <completion.contributor language="PHP" implementationClass="fr.adrienbrault.idea.symfony2plugin.codeInsight.completion.CompletionContributor"/>
+ <completion.contributor language="any" implementationClass="fr.adrienbrault.idea.symfony2plugin.codeInsight.completion.CompletionContributor"/>
  <gotoDeclarationHandler implementation="fr.adrienbrault.idea.symfony2plugin.codeInsight.navigation.GotoHandler"/>
 
  <completion.contributor language="PHP" implementationClass="fr.adrienbrault.idea.symfony2plugin.completion.ConstantEnumCompletionContributor"/>

src/fr/adrienbrault/idea/symfony2plugin/codeInsight/GotoCompletionProviderInterface.java

@@ -13,6 +13,6 @@ public interface GotoCompletionProviderInterface {
  public Collection<LookupElement> getLookupElements();
 
  @NotNull
- public Collection<PsiElement> getPsiTargets(StringLiteralExpression element);
+ public Collection<PsiElement> getPsiTargets(PsiElement element);
 
 }

src/fr/adrienbrault/idea/symfony2plugin/codeInsight/completion/CompletionContributor.java

@@ -20,8 +20,8 @@ public CompletionContributor() {
  @Override
  protected void addCompletions(@NotNull CompletionParameters completionParameters, ProcessingContext processingContext, @NotNull CompletionResultSet completionResultSet) {
 
- PsiElement psiElement = completionParameters.getOriginalPosition();
- if (psiElement == null || !Symfony2ProjectComponent.isEnabled(psiElement)) {
+ PsiElement psiElement = completionParameters.getPosition();
+ if (!Symfony2ProjectComponent.isEnabled(psiElement)) {
  return;
  }
 

src/fr/adrienbrault/idea/symfony2plugin/codeInsight/navigation/GotoHandler.java

@@ -26,16 +26,11 @@ public PsiElement[] getGotoDeclarationTargets(PsiElement psiElement, int i, Edit
  return new PsiElement[0];
  }
 
- PsiElement parent = psiElement.getParent();
- if(!(parent instanceof StringLiteralExpression)) {
- return new PsiElement[0];
- }
-
  Collection<PsiElement> psiTargets = new ArrayList<PsiElement>();
  for(GotoCompletionContributor contributor: GotoCompletionUtil.getContributors(psiElement)) {
  GotoCompletionProviderInterface formReferenceCompletionContributor = contributor.getProvider(psiElement);
  if(formReferenceCompletionContributor != null) {
- psiTargets.addAll(formReferenceCompletionContributor.getPsiTargets((StringLiteralExpression) parent));
+ psiTargets.addAll(formReferenceCompletionContributor.getPsiTargets(psiElement));
  }
  }
 

src/fr/adrienbrault/idea/symfony2plugin/codeInsight/utils/GotoCompletionUtil.java

@@ -6,15 +6,17 @@
 import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionRegistrar;
 import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionRegistrarParameter;
 import fr.adrienbrault.idea.symfony2plugin.form.FormOptionGotoCompletionRegistrar;
+import fr.adrienbrault.idea.symfony2plugin.templating.BlockCompletionRegistrar;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
 import java.util.Collection;
 
 public class GotoCompletionUtil {
 
- private static GotoCompletionRegistrar[] CONTRIBUTORS = new FormOptionGotoCompletionRegistrar[] {
- new FormOptionGotoCompletionRegistrar()
+ private static GotoCompletionRegistrar[] CONTRIBUTORS = new GotoCompletionRegistrar[] {
+ new FormOptionGotoCompletionRegistrar(),
+ new BlockCompletionRegistrar(),
  };
 
  public static Collection<GotoCompletionContributor> getContributors(final PsiElement psiElement) {

src/fr/adrienbrault/idea/symfony2plugin/form/FormOptionGotoCompletionRegistrar.java

@@ -5,11 +5,13 @@
 import com.intellij.patterns.ElementPattern;
 import com.intellij.patterns.PlatformPatterns;
 import com.intellij.psi.PsiElement;
+import com.jetbrains.php.lang.PhpLanguage;
 import com.jetbrains.php.lang.psi.elements.*;
 import com.jetbrains.php.lang.psi.elements.impl.PhpTypedElementImpl;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2Icons;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2InterfacesUtil;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
+import fr.adrienbrault.idea.symfony2plugin.TwigHelper;
 import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionContributor;
 import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionProvider;
 import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionRegistrar;
@@ -28,7 +30,7 @@
 public class FormOptionGotoCompletionRegistrar implements GotoCompletionRegistrar {
 
  public void register(GotoCompletionRegistrarParameter registrar) {
- registrar.register(PlatformPatterns.psiElement(), new FormOptionBuilderCompletionContributor());
+ registrar.register(PlatformPatterns.psiElement().withLanguage(PhpLanguage.INSTANCE), new FormOptionBuilderCompletionContributor());
  }
 
  private static class FormOptionBuilderCompletionContributor implements GotoCompletionContributor {
@@ -90,9 +92,14 @@ public FormReferenceCompletionProvider(@NotNull PsiElement element, @Nullable St
  }
 
  @NotNull
- public Collection<PsiElement> getPsiTargets(StringLiteralExpression element) {
+ public Collection<PsiElement> getPsiTargets(PsiElement psiElement) {
 
- String value = element.getContents();
+ PsiElement element = psiElement.getParent();
+ if(!(element instanceof StringLiteralExpression)) {
+ return Collections.emptyList();
+ }
+
+ String value = ((StringLiteralExpression) element).getContents();
  if(StringUtils.isBlank(value)) {
  return Collections.emptyList();
  }

src/fr/adrienbrault/idea/symfony2plugin/templating/BlockCompletionRegistrar.java

@@ -0,0 +1,80 @@
+package fr.adrienbrault.idea.symfony2plugin.templating;
+
+import com.intellij.codeInsight.lookup.LookupElement;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.psi.PsiElement;
+import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
+import fr.adrienbrault.idea.symfony2plugin.TwigHelper;
+import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionContributor;
+import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionProvider;
+import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionRegistrar;
+import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionRegistrarParameter;
+import fr.adrienbrault.idea.symfony2plugin.templating.dict.TwigBlock;
+import fr.adrienbrault.idea.symfony2plugin.templating.dict.TwigBlockLookupElement;
+import fr.adrienbrault.idea.symfony2plugin.templating.dict.TwigBlockParser;
+import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
+import org.apache.commons.lang.StringUtils;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.*;
+
+public class BlockCompletionRegistrar implements GotoCompletionRegistrar {
+
+ public void register(GotoCompletionRegistrarParameter registrar) {
+
+ // {{ block('foo_block') }}
+ registrar.register(TwigHelper.getPrintBlockFunctionPattern("block"), new GotoCompletionContributor() {
+ @Nullable
+ @Override
+ public GotoCompletionProvider getProvider(@Nullable PsiElement psiElement) {
+
+ if (psiElement == null || !Symfony2ProjectComponent.isEnabled(psiElement)) {
+ return null;
+ }
+
+ return new BlockFunctionReferenceCompletionProvider(psiElement);
+ }
+ });
+ }
+
+ private static class BlockFunctionReferenceCompletionProvider extends GotoCompletionProvider {
+
+ public BlockFunctionReferenceCompletionProvider(@NotNull PsiElement element) {
+ super(element);
+ }
+
+ @NotNull
+ public Collection<PsiElement> getPsiTargets(PsiElement element) {
+
+ String blockName = PsiElementUtils.trimQuote(element.getText());
+ if(StringUtils.isBlank(blockName)) {
+ return Collections.emptyList();
+ }
+
+ return Arrays.asList(
+ TwigTemplateGoToDeclarationHandler.getBlockNameGoTo(element.getContainingFile(), blockName)
+ );
+
+ }
+
+ @NotNull
+ public Collection<LookupElement> getLookupElements() {
+
+ Collection<LookupElement> lookupElements = new ArrayList<LookupElement>();
+
+ Map<String, VirtualFile> twigFilesByName = TwigHelper.getTwigFilesByName(getElement().getProject());
+ List<TwigBlock> blocks = new TwigBlockParser(twigFilesByName).walk(getElement().getContainingFile());
+ List<String> uniqueList = new ArrayList<String>();
+ for (TwigBlock block : blocks) {
+ if(!uniqueList.contains(block.getName())) {
+ uniqueList.add(block.getName());
+ lookupElements.add(new TwigBlockLookupElement(block));
+ }
+ }
+
+ return lookupElements;
+ }
+
+ }
+}