add service suggestions for xml call arguments

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/dic/ServiceCompletionProvider.java

@@ -10,6 +10,7 @@
 import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
 import fr.adrienbrault.idea.symfony2plugin.action.ui.SymfonyCreateService;
 import fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion.ServiceSuggestionCollector;
+import fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion.XmlCallServiceSuggestionCollector;
 import fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion.XmlConstructServiceSuggestionCollector;
 import fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion.YamlConstructServiceSuggestionCollector;
 import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
@@ -25,6 +26,7 @@ public class ServiceCompletionProvider extends CompletionProvider<CompletionPara
  private static ServiceSuggestionCollector[] COLLECTORS = new ServiceSuggestionCollector[] {
  new XmlConstructServiceSuggestionCollector(),
  new YamlConstructServiceSuggestionCollector(),
+ new XmlCallServiceSuggestionCollector(),
  };
 
  public void addCompletions(@NotNull CompletionParameters parameters, ProcessingContext context, @NotNull CompletionResultSet resultSet) {

src/fr/adrienbrault/idea/symfony2plugin/dic/container/suggestion/XmlCallServiceSuggestionCollector.java

@@ -0,0 +1,36 @@
+package fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion;
+
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.xml.XmlFile;
+import com.intellij.psi.xml.XmlTokenType;
+import fr.adrienbrault.idea.symfony2plugin.dic.ContainerService;
+import fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion.utils.ServiceSuggestionUtil;
+import fr.adrienbrault.idea.symfony2plugin.dic.container.util.ServiceContainerUtil;
+import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+import java.util.Collections;
+
+/**
+ * @author Daniel Espendiller <daniel@espendiller.net>
+ *
+ * <service class="Foo">
+ * <call method="setFoo">
+ * <argument type="service" id="<caret>" />
+ * </call>
+ * </service>
+ */
+public class XmlCallServiceSuggestionCollector implements ServiceSuggestionCollector {
+
+ @NotNull
+ public Collection<String> collect(@NotNull PsiElement psiElement, @NotNull Collection<ContainerService> serviceMap) {
+ if(!(psiElement.getContainingFile() instanceof XmlFile) || psiElement.getNode().getElementType() != XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN) {
+ return Collections.emptyList();
+ }
+
+ return ServiceSuggestionUtil.createSuggestions(ServiceContainerUtil.getXmlCallTypeHint(
+ psiElement, new ContainerCollectionResolver.LazyServiceCollector(psiElement.getProject())
+ ), serviceMap);
+ }
+}

src/fr/adrienbrault/idea/symfony2plugin/dic/container/suggestion/XmlConstructServiceSuggestionCollector.java

@@ -1,19 +1,12 @@
 package fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion;
 
 import com.intellij.psi.PsiElement;
-import com.intellij.psi.util.PsiTreeUtil;
-import com.intellij.psi.xml.XmlAttributeValue;
 import com.intellij.psi.xml.XmlFile;
-import com.intellij.psi.xml.XmlTag;
 import com.intellij.psi.xml.XmlTokenType;
-import com.intellij.util.Function;
-import com.intellij.util.containers.ContainerUtil;
-import com.jetbrains.php.lang.psi.elements.Method;
-import com.jetbrains.php.lang.psi.elements.PhpClass;
-import fr.adrienbrault.idea.symfony2plugin.config.xml.XmlServiceContainerAnnotator;
 import fr.adrienbrault.idea.symfony2plugin.dic.ContainerService;
-import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
-import fr.adrienbrault.idea.symfony2plugin.util.psi.PsiElementAssertUtil;
+import fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion.utils.ServiceSuggestionUtil;
+import fr.adrienbrault.idea.symfony2plugin.dic.container.util.ServiceContainerUtil;
+import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.Collection;
@@ -30,58 +23,9 @@ public Collection<String> collect(@NotNull PsiElement psiElement, @NotNull Colle
  return Collections.emptyList();
  }
 
- XmlAttributeValue xmlAttributeValue = PsiTreeUtil.getParentOfType(psiElement, XmlAttributeValue.class);
- if(xmlAttributeValue == null) {
- return Collections.emptyList();
- }
-
- XmlTag argumentTag = PsiTreeUtil.getParentOfType(psiElement, XmlTag.class);
- if(argumentTag == null) {
- return Collections.emptyList();
- }
-
- XmlTag serviceTag = PsiElementAssertUtil.getParentOfTypeOrNull(argumentTag, XmlTag.class);
- if(serviceTag == null) {
- return Collections.emptyList();
- }
-
- if(!serviceTag.getName().equals("service")) {
- return Collections.emptyList();
- }
-
- // service/argument[id]
-
- String serviceDefName = serviceTag.getAttributeValue("class");
- if(serviceDefName != null) {
- PhpClass phpClass = ServiceUtil.getResolvedClassDefinition(psiElement.getProject(), serviceDefName);
-
- // check type hint on constructor
- if(phpClass != null) {
- Method constructor = phpClass.getConstructor();
- if(constructor != null) {
-
- Collection<ContainerService> suggestions = ServiceUtil.getServiceSuggestionsForTypeHint(
- constructor,
- XmlServiceContainerAnnotator.getArgumentIndex(argumentTag),
- serviceMap
- );
-
- if(suggestions.size() == 0) {
- return Collections.emptyList();
- }
-
- return ContainerUtil.map(suggestions, new Function<ContainerService, String>() {
- @Override
- public String fun(ContainerService containerService) {
- return containerService.getName();
- }
- });
- }
- }
-
- }
-
- return Collections.emptyList();
+ return ServiceSuggestionUtil.createSuggestions(ServiceContainerUtil.getXmlConstructorTypeHint(
+ psiElement, new ContainerCollectionResolver.LazyServiceCollector(psiElement.getProject())
+ ), serviceMap);
  }
 
 }

src/fr/adrienbrault/idea/symfony2plugin/dic/container/suggestion/YamlConstructServiceSuggestionCollector.java

@@ -1,16 +1,13 @@
 package fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion;
 
 import com.intellij.psi.PsiElement;
-import com.intellij.util.containers.ContainerUtil;
 import fr.adrienbrault.idea.symfony2plugin.dic.ContainerService;
-import fr.adrienbrault.idea.symfony2plugin.dic.container.dict.ServiceTypeHint;
+import fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion.utils.ServiceSuggestionUtil;
 import fr.adrienbrault.idea.symfony2plugin.dic.container.util.ServiceContainerUtil;
 import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
-import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.Collection;
-import java.util.Collections;
 
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
@@ -19,24 +16,8 @@ public class YamlConstructServiceSuggestionCollector implements ServiceSuggestio
 
  @NotNull
  public Collection<String> collect(@NotNull PsiElement psiElement, @NotNull Collection<ContainerService> serviceMap) {
- ServiceTypeHint methodTypeHint = ServiceContainerUtil.getYamlConstructorTypeHint(
+ return ServiceSuggestionUtil.createSuggestions(ServiceContainerUtil.getYamlConstructorTypeHint(
  psiElement, new ContainerCollectionResolver.LazyServiceCollector(psiElement.getProject())
- );
-
- if(methodTypeHint == null) {
- return Collections.emptyList();
- }
-
- Collection<ContainerService> suggestions = ServiceUtil.getServiceSuggestionsForTypeHint(
- methodTypeHint.getMethod(),
- methodTypeHint.getIndex(),
- serviceMap
- );
-
- if(suggestions.size() == 0) {
- return Collections.emptyList();
- }
-
- return ContainerUtil.map(suggestions, ContainerService::getName);
+ ), serviceMap);
  }
 }

src/fr/adrienbrault/idea/symfony2plugin/dic/container/suggestion/utils/ServiceSuggestionUtil.java

@@ -0,0 +1,44 @@
+package fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion.utils;
+
+import com.intellij.psi.PsiElement;
+import com.intellij.util.containers.ContainerUtil;
+import fr.adrienbrault.idea.symfony2plugin.dic.ContainerService;
+import fr.adrienbrault.idea.symfony2plugin.dic.container.dict.ServiceTypeHint;
+import fr.adrienbrault.idea.symfony2plugin.dic.container.util.ServiceContainerUtil;
+import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
+import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Collection;
+import java.util.Collections;
+
+/**
+ * @author Daniel Espendiller <daniel@espendiller.net>
+ */
+public class ServiceSuggestionUtil {
+
+ @NotNull
+ private static Collection<String> createServiceCollection(@NotNull ServiceTypeHint serviceTypeHint, @NotNull Collection<ContainerService> serviceMap) {
+ Collection<ContainerService> suggestions = ServiceUtil.getServiceSuggestionsForTypeHint(
+ serviceTypeHint.getMethod(),
+ serviceTypeHint.getIndex(),
+ serviceMap
+ );
+
+ if(suggestions.size() == 0) {
+ return Collections.emptyList();
+ }
+
+ return ContainerUtil.map(suggestions, ContainerService::getName);
+ }
+
+ @NotNull
+ public static Collection<String> createSuggestions(@Nullable ServiceTypeHint serviceTypeHint, @NotNull Collection<ContainerService> serviceMap) {
+ if(serviceTypeHint == null) {
+ return Collections.emptyList();
+ }
+
+ return ServiceSuggestionUtil.createServiceCollection(serviceTypeHint, serviceMap);
+ }
+}

src/fr/adrienbrault/idea/symfony2plugin/dic/container/util/ServiceContainerUtil.java

@@ -5,13 +5,15 @@
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.util.PsiTreeUtil;
-import com.intellij.psi.xml.XmlDocument;
-import com.intellij.psi.xml.XmlFile;
-import com.intellij.psi.xml.XmlTag;
+import com.intellij.psi.xml.*;
 import com.intellij.util.Consumer;
+import com.intellij.util.containers.ContainerUtil;
 import com.jetbrains.php.lang.psi.elements.Method;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
+import fr.adrienbrault.idea.symfony2plugin.config.xml.XmlHelper;
+import fr.adrienbrault.idea.symfony2plugin.config.xml.XmlServiceContainerAnnotator;
 import fr.adrienbrault.idea.symfony2plugin.config.yaml.YamlAnnotator;
+import fr.adrienbrault.idea.symfony2plugin.dic.ContainerService;
 import fr.adrienbrault.idea.symfony2plugin.dic.attribute.value.AttributeValueInterface;
 import fr.adrienbrault.idea.symfony2plugin.dic.attribute.value.XmlTagAttributeValue;
 import fr.adrienbrault.idea.symfony2plugin.dic.attribute.value.YamlKeyValueAttributeValue;
@@ -22,6 +24,7 @@
 import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
 import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
 import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.psi.PsiElementAssertUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlHelper;
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
@@ -30,6 +33,7 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
@@ -211,4 +215,122 @@ public static ServiceTypeHint getYamlConstructorTypeHint(@NotNull PsiElement psi
  psiElement
  );
  }
+
+ /**
+ * <services>
+ * <service class="Foo\\Bar\\Car">
+ * <argument type="service" id="<caret>" />
+ * </service>
+ * </services>
+ */
+ @Nullable
+ public static ServiceTypeHint getXmlConstructorTypeHint(@NotNull PsiElement psiElement, @NotNull ContainerCollectionResolver.LazyServiceCollector lazyServiceCollector) {
+ if(!(psiElement.getContainingFile() instanceof XmlFile) || psiElement.getNode().getElementType() != XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN) {
+ return null;
+ }
+
+ XmlAttributeValue xmlAttributeValue = PsiTreeUtil.getParentOfType(psiElement, XmlAttributeValue.class);
+ if(xmlAttributeValue == null) {
+ return null;
+ }
+
+ XmlTag argumentTag = PsiTreeUtil.getParentOfType(psiElement, XmlTag.class);
+ if(argumentTag == null) {
+ return null;
+ }
+
+ XmlTag serviceTag = PsiElementAssertUtil.getParentOfTypeOrNull(argumentTag, XmlTag.class);
+ if(serviceTag == null) {
+ return null;
+ }
+
+ if(!serviceTag.getName().equals("service")) {
+ return null;
+ }
+
+ // service/argument[id]
+ String serviceDefName = serviceTag.getAttributeValue("class");
+ if(serviceDefName != null) {
+ PhpClass phpClass = ServiceUtil.getResolvedClassDefinition(psiElement.getProject(), serviceDefName);
+
+ // check type hint on constructor
+ if(phpClass != null) {
+ Method constructor = phpClass.getConstructor();
+ if(constructor != null) {
+ return new ServiceTypeHint(constructor, getArgumentIndex(argumentTag), psiElement);
+ }
+ }
+
+ }
+
+ return null;
+ }
+
+ /**
+ * <services>
+ * <service class="Foo\\Bar\\Car">
+ * <call method="foo"></call>
+ * <argument type="service" id="<caret>" />
+ * </call>
+ * </service>
+ * </services>
+ */
+ @Nullable
+ public static ServiceTypeHint getXmlCallTypeHint(@NotNull PsiElement psiElement, @NotNull ContainerCollectionResolver.LazyServiceCollector lazyServiceCollector) {
+ // search for parent service definition
+ XmlTag currentXmlTag = PsiTreeUtil.getParentOfType(psiElement, XmlTag.class);
+ XmlTag parentXmlTag = PsiTreeUtil.getParentOfType(currentXmlTag, XmlTag.class);
+ if(parentXmlTag == null) {
+ return null;
+ }
+
+ String name = parentXmlTag.getName();
+ if(!"call".equals(name)) {
+ return null;
+ }
+
+ // service/call/argument[id]
+ XmlAttribute methodAttribute = parentXmlTag.getAttribute("method");
+ if(methodAttribute != null) {
+ String methodName = methodAttribute.getValue();
+ XmlTag serviceTag = parentXmlTag.getParentTag();
+
+ // get service class
+ if(serviceTag != null && "service".equals(serviceTag.getName())) {
+ XmlAttribute classAttribute = serviceTag.getAttribute("class");
+ if(classAttribute != null) {
+
+ String serviceDefName = classAttribute.getValue();
+ if(serviceDefName != null) {
+ PhpClass phpClass = ServiceUtil.getResolvedClassDefinition(psiElement.getProject(), serviceDefName);
+
+ // finally check method type hint
+ if(phpClass != null) {
+ Method method = phpClass.findMethodByName(methodName);
+ if(method != null) {
+ return new ServiceTypeHint(method, getArgumentIndex(currentXmlTag), psiElement);
+ }
+ }
+ }
+ }
+ }
+ }
+
+ return null;
+ }
+
+ private static int getArgumentIndex(@NotNull XmlTag xmlTag) {
+
+ PsiElement psiElement = xmlTag;
+ int index = 0;
+
+ while (psiElement != null) {
+ psiElement = psiElement.getPrevSibling();
+ if(psiElement instanceof XmlTag && "argument".equalsIgnoreCase(((XmlTag) psiElement).getName())) {
+ index++;
+ }
+ }
+
+ return index;
+ }
 }