Class name autocompletion in the middle of the value in xml/yaml services #337

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/util/PhpElementsUtil.java

@@ -745,4 +745,68 @@ protected boolean accept(PsiReference psiReference) {
 
     }
 
+    /**
+     * Try to visit possible class name for PsiElements with text like "Foo\|Bar", "Foo|\Bar", "\Foo|\Bar"
+     * Cursor must have position in PsiElement
+     *
+     * @param psiElement the element context, cursor should be in it
+     * @param cursorOffset current cursor editor eg from completion context
+     * @param visitor callback on matching class
+     */
+    public static void visitNamespaceClassForCompletion(PsiElement psiElement, int cursorOffset, ClassForCompletionVisitor visitor) {
+
+        int cursorOffsetClean = cursorOffset - psiElement.getTextOffset();
+        if(cursorOffsetClean < 1) {
+            return;
+        }
+
+        String content = psiElement.getText();
+        int length = content.length();
+        if(!(length >= cursorOffsetClean)) {
+            return;
+        }
+
+        String beforeCursor = content.substring(0, cursorOffsetClean);
+        boolean isValid;
+
+        // espend\|Container, espend\Cont|ainer <- fallback to last full namespace
+        // espend|\Container <- only on known namespace "espend"
+        String namespace = beforeCursor;
+
+        // if no backslash or its equal in first position, fallback on namespace completion
+        int lastSlash = beforeCursor.lastIndexOf("\\");
+        if(lastSlash <= 0) {
+            isValid = PhpIndexUtil.hasNamespace(psiElement.getProject(), beforeCursor);
+        } else {
+            isValid = true;
+            namespace = beforeCursor.substring(0, lastSlash);
+        }
+
+        if(!isValid) {
+            return;
+        }
+
+        // format namespaces and add prefix for fluent completion
+        String prefix = "";
+        if(namespace.startsWith("\\")) {
+            prefix = "\\";
+        } else {
+            namespace = "\\" + namespace;
+        }
+
+        // search classes in current namespace and child namespaces
+        for(PhpClass phpClass: PhpIndexUtil.getPhpClassInsideNamespace(psiElement.getProject(), namespace)) {
+            String presentableFQN = phpClass.getPresentableFQN();
+            if(presentableFQN != null && fr.adrienbrault.idea.symfony2plugin.util.StringUtils.startWithEqualClassname(presentableFQN, beforeCursor)) {
+                visitor.visit(phpClass, presentableFQN, prefix);
+            }
+
+        }
+
+    }
+
+    public static interface ClassForCompletionVisitor {
+        public void visit(PhpClass phpClass, String presentableFQN, String prefix);
+    }
+
 }

src/fr/adrienbrault/idea/symfony2plugin/util/PhpIndexUtil.java

@@ -48,4 +48,14 @@ public boolean process(PhpNamespace phpNamespace) {
         return phpClasses;
     }
 
+    public static boolean hasNamespace(Project project, String namespaceName) {
+
+        if(!namespaceName.startsWith("\\")) {
+            namespaceName = "\\" + namespaceName;
+        }
+
+        return PhpIndex.getInstance(project).getChildNamespacesByParentName(namespaceName + "\\").size() > 0;
+
+    }
+
 }

src/fr/adrienbrault/idea/symfony2plugin/util/StringUtils.java

@@ -33,4 +33,23 @@ public static String ucfirst(String chaine){
         return chaine.substring(0, 1).toUpperCase() + chaine.substring(1);
     }
 
+    /**
+     * Simple string compare if class name is in same namespace
+     * Starting backslash doesnt break equal check
+     *
+     * @param class1 \Foo\Class
+     * @param class2 \Foo or Foo
+     */
+    public static boolean startWithEqualClassname(String class1, String class2) {
+        if(class1.startsWith("\\")) {
+            class1 = class1.substring(1);
+        }
+
+        if(class2.startsWith("\\")) {
+            class2 = class2.substring(1);
+        }
+
+        return class1.startsWith(class2);
+    }
+
 }

src/fr/adrienbrault/idea/symfony2plugin/util/completion/PhpClassAndParameterCompletionProvider.java

@@ -4,32 +4,42 @@
 import com.intellij.codeInsight.completion.CompletionParameters;
 import com.intellij.codeInsight.completion.CompletionProvider;
 import com.intellij.codeInsight.completion.CompletionResultSet;
+import com.intellij.codeInsight.lookup.LookupElementBuilder;
 import com.intellij.psi.PsiElement;
 import com.intellij.util.ProcessingContext;
 import com.jetbrains.php.PhpIndex;
 import com.jetbrains.php.completion.PhpLookupElement;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.jetbrains.php.lang.psi.stubs.indexes.PhpClassIndex;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
 import fr.adrienbrault.idea.symfony2plugin.config.component.ParameterLookupElement;
 import fr.adrienbrault.idea.symfony2plugin.config.yaml.ParameterPercentWrapInsertHandler;
 import fr.adrienbrault.idea.symfony2plugin.dic.ContainerParameter;
 import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
+import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.Map;
 
 public class PhpClassAndParameterCompletionProvider extends CompletionProvider<CompletionParameters> {
 
-    public void addCompletions(@NotNull CompletionParameters parameters, ProcessingContext context, @NotNull CompletionResultSet resultSet) {
+    public void addCompletions(@NotNull CompletionParameters parameters, ProcessingContext context, final @NotNull CompletionResultSet resultSet) {
 
         PsiElement psiElement = parameters.getOriginalPosition();
         if(psiElement == null || !Symfony2ProjectComponent.isEnabled(psiElement)) {
             return;
         }
 
-        PhpIndex phpIndex = PhpIndex.getInstance(psiElement.getProject());
+        // Foo\|Bar
+        // Foo|\Bar
+        PhpElementsUtil.visitNamespaceClassForCompletion(psiElement, parameters.getOffset(), new PhpElementsUtil.ClassForCompletionVisitor() {
+            @Override
+            public void visit(PhpClass phpClass, String presentableFQN, String prefix) {
+                resultSet.addElement(LookupElementBuilder.create(prefix + presentableFQN).withIcon(phpClass.getIcon()));
+            }
+        });
 
-        for (String className : phpIndex.getAllClassNames(resultSet.getPrefixMatcher())) {
+        for (String className : PhpIndex.getInstance(psiElement.getProject()).getAllClassNames(resultSet.getPrefixMatcher())) {
             resultSet.addElement(new PhpLookupElement(className, PhpClassIndex.KEY, parameters.getOriginalFile().getProject(), PhpClassReferenceInsertHandler.getInstance()));
         }