add twig "use" tag support in block name parser Haehnchen#266

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/TwigHelper.java

@@ -771,6 +771,28 @@ public static ElementPattern<PsiElement> getTwigMacroNamePattern() {
  .withLanguage(TwigLanguage.INSTANCE);
  }
 
+ public static ElementPattern<PsiElement> getTwigTagUseNamePattern() {
+
+ // {% use '<foo>' %}
+
+ //noinspection unchecked
+ return PlatformPatterns
+ .psiElement(TwigTokenTypes.STRING_TEXT)
+ .withParent(PlatformPatterns.psiElement(
+ TwigElementTypes.TAG
+ ))
+ .afterLeafSkipping(
+ PlatformPatterns.or(
+ PlatformPatterns.psiElement(PsiWhiteSpace.class),
+ PlatformPatterns.psiElement(TwigTokenTypes.WHITE_SPACE),
+ PlatformPatterns.psiElement(TwigTokenTypes.SINGLE_QUOTE),
+ PlatformPatterns.psiElement(TwigTokenTypes.DOUBLE_QUOTE)
+ ),
+ PlatformPatterns.psiElement(TwigTokenTypes.TAG_NAME).withText("use")
+ )
+ .withLanguage(TwigLanguage.INSTANCE);
+ }
+
  public static ElementPattern<PsiElement> getTwigMacroNameKnownPattern(String macroName) {
 
  // {% macro <foo>(user) %}

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

@@ -53,7 +53,7 @@ public Collection<PsiElement> getPsiTargets(PsiElement element) {
  }
 
  return Arrays.asList(
- TwigTemplateGoToDeclarationHandler.getBlockNameGoTo(element.getContainingFile(), blockName)
+ TwigTemplateGoToDeclarationHandler.getBlockNameGoTo(element.getContainingFile(), blockName, true)
  );
 
  }
@@ -64,7 +64,7 @@ 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<TwigBlock> blocks = new TwigBlockParser(twigFilesByName).withSelfBlocks(true).walk(getElement().getContainingFile());
  List<String> uniqueList = new ArrayList<String>();
  for (TwigBlock block : blocks) {
  if(!uniqueList.contains(block.getName())) {

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

@@ -154,8 +154,12 @@ public static PsiElement[] getBlockGoTo(PsiElement psiElement) {
  }
 
  public static PsiElement[] getBlockNameGoTo(PsiFile psiFile, String blockName) {
+ return getBlockNameGoTo(psiFile, blockName, false);
+ }
+
+ public static PsiElement[] getBlockNameGoTo(PsiFile psiFile, String blockName, boolean withSelfBlocks) {
  Map<String, VirtualFile> twigFilesByName = TwigHelper.getTwigFilesByName(psiFile.getProject());
- List<TwigBlock> blocks = new TwigBlockParser(twigFilesByName).walk(psiFile);
+ List<TwigBlock> blocks = new TwigBlockParser(twigFilesByName).withSelfBlocks(withSelfBlocks).walk(psiFile);
  List<PsiElement> psiElements = new ArrayList<PsiElement>();
  for (TwigBlock block : blocks) {
  if(block.getName().equals(blockName)) {

src/fr/adrienbrault/idea/symfony2plugin/templating/dict/TwigBlockParser.java

@@ -1,22 +1,30 @@
 package fr.adrienbrault.idea.symfony2plugin.templating.dict;
 
 import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiManager;
+import com.intellij.psi.PsiRecursiveElementWalkingVisitor;
+import com.intellij.psi.util.PsiTreeUtil;
 import com.jetbrains.twig.TwigFile;
+import com.jetbrains.twig.elements.TwigCompositeElement;
+import com.jetbrains.twig.elements.TwigElementTypes;
 import fr.adrienbrault.idea.symfony2plugin.TwigHelper;
+import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
+import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.Nullable;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 public class TwigBlockParser {
 
  public static String EXTENDS_TEMPLATE_NAME_PATTERN = "^[\\s+]*\\{%\\s+extends[\\s+]*['|\"](.*?)['|\"]";
 
+ private boolean withSelfBlock = false;
+
  private Map<String, VirtualFile> twigFilesByName;
 
  public TwigBlockParser(Map<String, VirtualFile> twigFilesByName) {
@@ -36,7 +44,8 @@ public List<TwigBlock> walk(@Nullable PsiFile file, String shortcutName, List<Tw
  // @TODO: we dont use psielements here, check if Pattern faster or not
 
  // dont match on self file !?
- if(depth > 0) {
+ if(depth > 0 || (withSelfBlock && depth == 0)) {
+ // @TODO: migrate to psi elements
  Matcher matcherBlocks = Pattern.compile("\\{%[\\s+]*block[\\s+]*(.*?)[\\s+]*%}").matcher(file.getText());
  while(matcherBlocks.find()){
  current.add(new TwigBlock(matcherBlocks.group(1), shortcutName, file));
@@ -48,20 +57,57 @@ public List<TwigBlock> walk(@Nullable PsiFile file, String shortcutName, List<Tw
  return current;
  }
 
+ final Map<VirtualFile, String> virtualFiles = new HashMap<VirtualFile, String>();
+
+ // @TODO: migrate to psi elements
+ // {% extends 'foo' %}
  // find extend in self
  Matcher matcher = Pattern.compile(EXTENDS_TEMPLATE_NAME_PATTERN).matcher(file.getText());
  while(matcher.find()){
  String templateName = TwigHelper.normalizeTemplateName(matcher.group(1));
  if(twigFilesByName.containsKey(templateName)) {
- VirtualFile virtualFile = twigFilesByName.get(templateName);
- PsiFile psiFile = PsiManager.getInstance(file.getProject()).findFile(virtualFile);
- if(psiFile instanceof TwigFile) {
- this.walk(psiFile, matcher.group(1), current, depth);
- }
+ virtualFiles.put(twigFilesByName.get(templateName), templateName);
+ }
+ }
+
+ // {% use 'foo' %}
+ for(TwigCompositeElement twigCompositeElement: PsiTreeUtil.getChildrenOfTypeAsList(file, TwigCompositeElement.class)) {
+ if(twigCompositeElement.getNode().getElementType() == TwigElementTypes.TAG) {
+ twigCompositeElement.acceptChildren(new PsiRecursiveElementWalkingVisitor() {
+ @Override
+ public void visitElement(PsiElement element) {
+
+ if(TwigHelper.getTwigTagUseNamePattern().accepts(element)) {
+
+ String templateName = PsiElementUtils.trimQuote(element.getText());
+ if(StringUtils.isNotBlank(templateName)) {
+ String templateNameNormalized = TwigHelper.normalizeTemplateName(TwigHelper.normalizeTemplateName(templateName));
+ if(twigFilesByName.containsKey(templateNameNormalized)) {
+ virtualFiles.put(twigFilesByName.get(templateName), templateNameNormalized);
+ }
+ }
+
+ }
+
+ super.visitElement(element);
+ }
+ });
+ }
+ }
+
+ for(Map.Entry<VirtualFile, String> entry : virtualFiles.entrySet()) {
+ PsiFile psiFile = PsiManager.getInstance(file.getProject()).findFile(entry.getKey());
+ if(psiFile instanceof TwigFile) {
+ this.walk(psiFile, TwigUtil.getFoldingTemplateNameOrCurrent(entry.getValue()), current, depth);
  }
  }
 
  return current;
  }
 
+ public TwigBlockParser withSelfBlocks(boolean withSelfBlock) {
+ this.withSelfBlock = withSelfBlock;
+ return this;
+ }
+
 }